file_pool 0.3.10 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7f119ba9e27968da351cae536fb49dcb7e8c967
+  data.tar.gz: 5f774c28a82bbca70a397343132c3258aea9cadd
+SHA512:
+  metadata.gz: ed3d39e566dc996e3c0f5909443190514770bd1a48c87fbbf65fdc950d2a92bb0e6c5df897070a5acdda1fc82157d2b40bf27fdf4d8eca48b70b0adec4536f2e
+  data.tar.gz: 366078e33a3fa105a5254cc41acaf625033ad3daff5417bcecc1487b3b23f99a345e8fc03dc3389983affe6478cd600d9451d5c6b5a3f38d5e494f7af3cec581

data/lib/file_pool/version.rb

@@ -1,3 +1,3 @@
 module FilePool
-  VERSION = "0.3.10"
+  VERSION = "0.4.0"
 end

data/lib/file_pool.rb

@@ -26,33 +26,13 @@ module FilePool
   #   * :encryption_block_size (Integer) sets the block size for
   #     encryption/decryption in bytes. Larger blocks need more memory and less time (less IO).
   #     Defaults to 1'048'576 (1 MiB).
-  #   * :copy_source (true,false)
-  #     if +false+ files added to the pool are hard-linked with the source if source and file pool 
-  #     are on the same file system (default). If set to +true+ files are always copied into the pool.
-  #   * :mode (Integer)
-  #     File mode to set on all files added to the pool. E.g. +mode:+ +0640+ for +rw-r-----+ or symbolic "u=wrx,go=rx"
-  #     (see Ruby stdlib FileUtils#chmod).
-  #     Note that the desired mode is not set if the file is hard-linked with the source. 
-  #     Use +copy_source:true+ when to ensure.
-  #   * :owner
-  #     Owner of the files added to the pool. 
-  #     Note that the desired owner is not set if the file is hard-linked with the source. 
-  #     Use +copy_source:true+ when to ensure.
-  #   * :group
-  #     Group of the files added to the pool. 
-  #     Note that the desired group is not set if the file is hard-linked with the source. 
-  #     Use +copy_source:true+ when to ensure.
   def self.setup root, options={}
-    unless(unknown = options.keys - [:encryption_block_size, :secrets_file, :copy_source, :mode, :owner, :group]).empty?
+    unless(unknown = options.keys - [:encryption_block_size, :secrets_file]).empty?
       puts "FilePool Warning: unknown option(s) passed to #setup: #{unknown.inspect}"
     end
     @@root = root
     @@crypted_mode = false
     @@block_size = options[:encryption_block_size] || (1024*1024)
-    @@copy_source = options[:copy_source] || false
-    @@mode = options[:mode]
-    @@group = options[:group]
-    @@owner = options[:owner]
     configure options[:secrets_file]
   end
 
@@ -70,49 +50,27 @@ module FilePool
   #
   # path (String)::
   #   path of the file to add.
-  # options (Hash)::
-  #   :background (true,false) adding large files can take long (esp. with encryption), +true+ won't block, default is +false+
   #
   # === Return Value:
   #
   # :: *String* containing a new unique ID for the file added.
-  def self.add! orig_path, options = {}
+  def self.add! path
     newid = uuid
+    target = path newid
 
-    child = fork do
-      target = path newid
-
-      if @@crypted_mode
-        FileUtils.mkpath(id2dir_secured newid)
-        path = crypt(orig_path)      
-      else
-        path = orig_path
-        FileUtils.mkpath(id2dir newid)
-      end
-
-      if !@@copy_source and (File.stat(path).dev == File.stat(File.dirname(target)).dev)
-        FileUtils.link(path, target)
-      else
-        FileUtils.copy(path, target)     
-      end
-
-      # don't chmod if orginal file is same as target (hard-linked) 
-      if File.stat(orig_path).ino != File.stat(File.dirname(target)).ino
-        FileUtils.chmod(@@mode, target) if @@mode
-        FileUtils.chown(@@owner, @@group, target)
-      end
-    end
-
-
-    if options[:background]
-      # don't wait, avoid zombies
-      Process.detach(child)
+    if @@crypted_mode
+      FileUtils.mkpath(id2dir_secured newid)
+      path = crypt(path)
     else
-      # block until done
-      Process.waitpid(child) 
+      FileUtils.mkpath(id2dir newid)
     end
+    FileUtils.link(path, target)
+
+    return newid
 
-    newid
+  rescue Errno::EXDEV
+    FileUtils.copy(path, target)
+    return newid
   end
 
   #
@@ -124,17 +82,15 @@ module FilePool
   #
   # source (String)::
   #   path of the file to add.
-  # options (Hash)::
-  #   :background (true,false) adding large files can take long (esp. with encryption), +true+ won't block, default is +false+
-  # 
+  #
   # === Return Value:
   #
   # :: *String* containing a new unique ID for the file added.
   # :: +false+ when the file could not be stored.
-  def self.add path, options = {}
-    self.add!(path, options)
+  def self.add path
+    self.add!(path)
 
-  rescue Exception
+  rescue Exception => ex
     return false
   end
 
@@ -167,7 +123,7 @@ module FilePool
       if @@crypted_mode
         if options[:decrypt]
           # return path of decrypted file (tmp path)
-          decrypt_to_file id2dir_secured(fid) + "/#{fid}"
+          decrypt id2dir_secured(fid) + "/#{fid}"
         else
           id2dir_secured(fid) + "/#{fid}"
         end
@@ -187,33 +143,6 @@ 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.
@@ -325,18 +254,18 @@ 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
     result = Tempfile.new 'FilePool-encrypt'
-    result.sync = true
-    buf = ''
+
+    result.set_encoding Encoding::BINARY,Encoding::BINARY
+    buf = ''.encode(Encoding::BINARY)
 
     File.open(path) do |inf|
-      size = 0
-      while inf.read(@@block_size, buf)        
-        result << cipher.update(buf)        
+      while inf.read(@@block_size, buf)
+        result << cipher.update(buf)
       end
       result << cipher.final
     end
@@ -346,7 +275,7 @@ module FilePool
   end
 
   #
-  # Decrypt file to a file in /tmp
+  # Decrypt a file and give a path to it.
   #
   # Returns the path to the decrypted file.
   #
@@ -356,80 +285,25 @@ 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
-
-  #
-  # 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
+  # :: *String*Path and name of the crypted file.
+  def self.decrypt path
+    decipher = create_decipher
+    # Now decrypt the data:
+    output = Tempfile.new 'FilePool-decrypt'
 
-    # in parent
-    Process.detach(child) # not waiting for it
-    pipe_write.close
-    pipe_read 
-  end
+    output.set_encoding Encoding::BINARY,Encoding::BINARY
+    buf = ''.encode(Encoding::BINARY)
 
-  #
-  # 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 = ''
-
-    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
+    File.open(path) do |inf|
+      while inf.read(@@block_size, buf)
+        output << decipher.update(buf)
       end
+      output << decipher.final
     end
 
-    out_io << decipher.final    
-    nil
+    output.open # re-open for reading, prevents early deletion of tempfile
+    output.path
   end
 
   #

metadata

@@ -1,89 +1,65 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: file_pool
-version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 10
-  version: 0.3.10
+version: !ruby/object:Gem::Version
+  version: 0.4.0
 platform: ruby
-authors: 
-- "robokopp (Robert Anni\xC3\xA9s)"
+authors:
+- robokopp (Robert Anniés)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2018-10-24 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2017-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: uuidtools
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 1
-        - 2
+      - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 description: |
   FilePool helps to manage a large number of files in a Ruby
   project. It takes care of the storage of files in a balanced directory
   tree and generates unique identifiers for all files.
-
-email: 
+email:
 - robokopp@fernwerk.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- README.md
+files:
 - README.md
-files: 
 - lib/file_pool.rb
 - lib/file_pool/version.rb
-- README.md
-has_rdoc: true
 homepage: https://github.com/robokopp/file_pool
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Manage a large number files in a pool
 test_files: []
-
+has_rdoc: