file_pool 0.3.8 → 0.3.9

data/lib/file_pool/version.rb

@@ -1,3 +1,3 @@
 module FilePool
-  VERSION = "0.3.8"
+  VERSION = "0.3.9"
 end

data/lib/file_pool.rb

@@ -167,7 +167,7 @@ module FilePool
       if @@crypted_mode
         if options[:decrypt]
           # return path of decrypted file (tmp path)
-          decrypt id2dir_secured(fid) + "/#{fid}"
+          decrypt_to_file id2dir_secured(fid) + "/#{fid}"
         else
           id2dir_secured(fid) + "/#{fid}"
         end
@@ -187,6 +187,33 @@ module FilePool
     end
   end
 
+  # Returns an IO object providing an (unencrypted) stream of data of the given file ID
+  # To get the stream of the encrypted data pass :decrypt => false, as an option.
+  #
+  # === Parameters:
+  #
+  # fid (String)::
+  #   File ID which was generated by a previous #add operation.
+  #
+  # options (Hash)::
+  #   :decrypt (true,false) In encryption mode don't decrypt, but prioved the encrypted data. Defaults to +true+.
+  #
+  # === Return Value:
+  #
+  # :: *IO*, IO stream open for reading
+  # 
+  def self.stream fid, options={}
+    options[:decrypt] = true unless options[:decrypt] == false
+
+    if path = path(fid, :decrypt => false)
+      if @@crypted_mode and options[:decrypt]
+        decrypt_to_stream path
+      else
+        open(path)
+      end
+    end
+  end
+
   #
   # Remove a previously added file by its ID. Same as FilePool.remove,
   # but throws exceptions on failure.
@@ -298,7 +325,7 @@ module FilePool
   #
   # === Return Value:
   #
-  # :: *String*Path and name of the crypted file.
+  # :: *String* Path and name of the crypted file.
   def self.crypt path
     # Crypt the file in the temp folder and copy after
     cipher = create_cipher
@@ -320,7 +347,7 @@ module FilePool
   end
 
   #
-  # Decrypt a file and give a path to it.
+  # Decrypt file to a file in /tmp
   #
   # Returns the path to the decrypted file.
   #
@@ -330,26 +357,80 @@ module FilePool
   #   path of the file to decrypt.
   #
   # === Return Value:
+  # 
+  # :: *String* Path and name of the decrypted file.
+  def self.decrypt_to_file path
+    tmpfile = Tempfile.new 'FilePool-decrypt'
+
+    File.open(path) do |crpt|
+      decrypt_io crpt, tmpfile
+    end
+
+    tmpfile.open # re-open for reading, prevents early deletion of tempfile
+    tmpfile.path
+  end
+
   #
-  # :: *String*Path and name of the crypted file.
-  def self.decrypt path
-    decipher = create_decipher
-    # Now decrypt the data:
-    output = Tempfile.new 'FilePool-decrypt'
+  # Decrypt file to a stream (IO) non-blocking by forking a child process.
+  #
+  # === Parameters:
+  #
+  # path (String)::
+  #   path of the file to decrypt.
+  #
+  # === Return Value:
+  # 
+  # :: *IO* decrypted data as stream
+  def self.decrypt_to_stream path
 
+    pipe_read, pipe_write = IO.pipe
+
+    child = fork do
+      # in child process: decrypting
+      pipe_read.close
+
+      # open encrypted file
+      File.open(path) do |crpt|
+        decrypt_io crpt, pipe_write       
+      end
+
+      pipe_write.close
+    end
+
+    # in parent
+    Process.detach(child) # not waiting for it
+    pipe_write.close
+    pipe_read 
+  end
+
+  #
+  # Decrypts given IO blockwise and returns IO of decrypted data
+  # 
+  # === Parameters:
+  #
+  # in_io (IO)::
+  #   provide encrypted data, must be open for reading
+  # out_io (IO)::
+  #   provides decrypted data, must be open for writing
+  # 
+  # === Retrun value: 
+  # 
+  # nil
+  def self.decrypt_io in_io, out_io 
+    decipher = create_decipher
     buf = ''
 
-    File.open(path) do |inf|
-      while inf.read(@@block_size, buf)
-        output << decipher.update(buf)
-        output.flush
-        output.fsync
+    while in_io.read(@@block_size, buf)
+      out_io << decipher.update(buf)
+      if out_io.is_a?(File)
+        # avoid memory buffering
+        out_io.flush
+        out_io.fsync
       end
-      output << decipher.final
     end
 
-    output.open # re-open for reading, prevents early deletion of tempfile
-    output.path
+    out_io << decipher.final    
+    nil
   end
 
   #

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: file_pool
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 3
-  - 8
-  version: 0.3.8
+  - 9
+  version: 0.3.9
 platform: ruby
 authors: 
 - "robokopp (Robert Anni\xC3\xA9s)"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2018-10-22 00:00:00 +02:00
+date: 2018-10-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency