file_pool 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dce65030d2667be95a43bdf4c244cbbceb6b78e8
-  data.tar.gz: cf079a18ce07baecaa9ce661defdb7aa4edccf30
+  metadata.gz: 0bc512434b751b3cb4a8654b57ad512f389b9055
+  data.tar.gz: 5e8b5fb1e8cb897cfa0b6b683cc40498c2033cc3
 SHA512:
-  metadata.gz: dba3e1caded888906fb65ced0d07d0f5b55f28a2343f802813bb8e4e047cb00c9e758afde121a3b63869bed0ed40cba02576acf2d1505fb32598c51279a9afa8
-  data.tar.gz: b9d54a8a9a62c4c470bab8910677706b8ad99de19b43f302ff3474f8b6e8760db7be9c5f700ea1d26e85479c459a1ff8c903e8f2174925afca56469d7f83b435
+  metadata.gz: 4ca7a96294fd39d864a9b6440875246edc0369de448ff61dbf9c0e1d2615718d09c99da1cfe0a4a31ca1477a5d637538545cbd811063e0ad039b4f95ff50392a
+  data.tar.gz: 3e6666cabf58d6414e5b844462d7c6034b7adcb3c97942159d97fe7e0bfb329870d50a7a0317bd8c4c565cbee1071e681d238796eb00847a41c481909f82628b

data/lib/file_pool/version.rb

@@ -1,3 +1,4 @@
 module FilePool
-  VERSION = "0.3.1"
+  # Version 0.3.2
+  VERSION = "0.3.2"
 end

data/lib/file_pool.rb

@@ -10,8 +10,7 @@ module FilePool
   class InvalidFileId < Exception; end
 
   #
-  # Setup the root directory of the file pool root and specify where
-  # to write log messages
+  # Setup the root directory of the file pool and configure encryption
   #
   # === Parameters:
   #
@@ -19,9 +18,21 @@ module FilePool
   #   absolute path of the file pool's root directory under which all files will be stored.
   # config_file_path (String)::
   #   path to the config file of the filepool.
+  # options (Hash)::
+  #   * :secrets_file (String)
+  #     path to file containing key and IV for encryption (if omitted FilePool
+  #     does not encrypt/decrypt). If file is not present, the file is initialized with a
+  #     new random key and IV.
+  #   * :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).
   def self.setup root, options={}
+    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)
     configure options[:secrets_file]
   end
 
@@ -247,10 +258,17 @@ module FilePool
   def self.crypt path
     # Crypt the file in the temp folder and copy after
     cipher = create_cipher
-    result = Tempfile.new uuid
-    crypted_content = cipher.update(File.read(path))
-    crypted_content << cipher.final
-    result.write crypted_content
+    result = Tempfile.new 'FilePool-encrypt'
+
+    buf = ''
+
+    File.open(path) do |inf|
+      while inf.read(@@block_size, buf)
+        result << cipher.update(buf)
+      end
+      result << cipher.final
+    end
+
     result.close
     result.path
   end
@@ -271,12 +289,17 @@ module FilePool
   def self.decrypt path
     decipher = create_decipher
     # Now decrypt the data:
-    decrypted_content = decipher.update(File.read(path))
-    decrypted_content << decipher.final
-    # Put it in a temp file
-    output = Tempfile.new uuid
-    output.write decrypted_content
-    output.open
+    output = Tempfile.new 'FilePool-decrypt'
+
+    buf = ''
+    File.open(path) do |inf|
+      while inf.read(@@block_size, buf)
+        output << decipher.update(buf)
+      end
+      output << decipher.final
+    end
+
+    output.open # re-open for reading, prevents early deletion of tempfile
     output.path
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file_pool
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - robokopp (Robert Anniés)
@@ -38,8 +38,6 @@ files:
 - README.md
 - lib/file_pool.rb
 - lib/file_pool/version.rb
-- test/test_file_pool.rb
-- test/test_file_pool_encryption.rb
 homepage: https://github.com/robokopp/file_pool
 licenses: []
 metadata: {}
@@ -63,7 +61,5 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Manage a large number files in a pool
-test_files:
-- test/test_file_pool.rb
-- test/test_file_pool_encryption.rb
+test_files: []
 has_rdoc: 

data/test/test_file_pool.rb

@@ -1,85 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-
-require 'test/unit'
-require 'shoulda-context'
-require 'file_pool'
-
-class FilePoolTest < Test::Unit::TestCase
-
-  def setup
-    @test_dir = "#{File.dirname(__FILE__)}/files"
-    @pool_root = "#{File.dirname(__FILE__)}/fp_root"
-    FilePool.setup @pool_root
-  end
-
-  def teardown
-    FileUtils.rm_r(Dir.glob @pool_root+"/*")
-  end
-
-  context "File Pool" do
-    should "store files" do
-      fid = FilePool.add(@test_dir+"/a")
-
-      assert UUIDTools::UUID.parse(fid).valid?
-
-      md5_orig = Digest::MD5.hexdigest(File.open(@test_dir+"/a").read)
-      md5_pooled = Digest::MD5.hexdigest(File.open(FilePool.path(fid)).read)
-
-      assert_equal md5_orig, md5_pooled
-    end
-
-    should "return path from stored files" do
-
-      fidb = FilePool.add(@test_dir+"/b")
-      fidc = FilePool.add(@test_dir+"/c")
-      fidd = FilePool.add!(@test_dir+"/d")
-
-      assert_equal "#{@pool_root}/#{fidb[0,1]}/#{fidb[1,1]}/#{fidb[2,1]}/#{fidb}", FilePool.path(fidb)
-      assert_equal "#{@pool_root}/#{fidc[0,1]}/#{fidc[1,1]}/#{fidc[2,1]}/#{fidc}", FilePool.path(fidc)
-      assert_equal "#{@pool_root}/#{fidd[0,1]}/#{fidd[1,1]}/#{fidd[2,1]}/#{fidd}", FilePool.path(fidd)
-
-    end
-
-    should "remove files from pool" do
-
-      fidb = FilePool.add(@test_dir+"/b")
-      fidc = FilePool.add!(@test_dir+"/c")
-      fidd = FilePool.add!(@test_dir+"/d")
-
-      path_c = FilePool.path(fidc)
-      FilePool.remove(fidc)
-
-      assert !File.exist?(path_c)
-      assert File.exist?(FilePool.path(fidb))
-      assert File.exist?(FilePool.path(fidd))
-
-    end
-
-    should "throw excceptions when using add! and remove! on failure" do
-      assert_raises(FilePool::InvalidFileId) do
-        FilePool.remove!("invalid-id")
-      end
-
-      assert_raises(Errno::ENOENT) do
-        FilePool.remove!("61e9b2d1-1738-440d-9b3d-e3c64876f2b0")
-      end
-
-      assert_raises(Errno::ENOENT) do
-        FilePool.add!("/not/here/foo.png")
-      end
-
-    end
-
-    should "not throw exceptions when using add and remove on failure" do
-      assert !FilePool.remove("invalid-id")
-      assert !FilePool.remove("61e9b2d1-1738-440d-9b3d-e3c64876f2b0")
-      assert !FilePool.add("/not/here/foo.png")
-    end
-
-    should "detect whether file encrypted" do
-      fid = FilePool.add(@test_dir+"/a")
-      assert !FilePool.encrypted?(fid)
-    end
-  end
-end

data/test/test_file_pool_encryption.rb

@@ -1,105 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-
-require 'test/unit'
-require 'shoulda-context'
-require 'file_pool'
-
-class FilePoolEncryptionTest < Test::Unit::TestCase
-
-  def setup
-    @test_dir = "#{File.dirname(__FILE__)}/files"
-    @pool_root = "#{File.dirname(__FILE__)}/fp_root"
-    @file_pool_config = "#{File.dirname(__FILE__)}/file_pool_cfg.yml"
-    FilePool.setup @pool_root, :secrets_file => @file_pool_config
-  end
-
-  def teardown
-    FileUtils.rm_r(Dir.glob @pool_root+"/*")
-    FileUtils.rm_r(Dir.glob "#{@pool_root}_secured/*")
-    FileUtils.rm_r(Dir.glob @file_pool_config)
-  end
-
-  context "File Pool" do
-    should "store encrypted files" do
-      fid = FilePool.add(@test_dir+"/a")
-
-      assert UUIDTools::UUID.parse(fid).valid?
-
-      md5_orig = Digest::MD5.hexdigest(File.open(@test_dir+"/a").read)
-      md5_pooled = Digest::MD5.hexdigest(File.open(FilePool.path(fid)).read)
-
-      assert_equal md5_orig, md5_pooled
-    end
-
-    should "return path from stored encrypted files is in the tmp folder" do
-
-      fida = FilePool.add(@test_dir+"/a")
-      assert UUIDTools::UUID.parse(fida).valid?
-
-      fidb = FilePool.add(@test_dir+"/b")
-      assert UUIDTools::UUID.parse(fidb).valid?
-
-      fidc = FilePool.add(@test_dir+"/c")
-      assert UUIDTools::UUID.parse(fidc).valid?
-
-      fidd = FilePool.add!(@test_dir+"/d")
-      assert UUIDTools::UUID.parse(fidd).valid?
-
-      assert_equal Digest::MD5.hexdigest(File.open(@test_dir+"/a").read),
-                     Digest::MD5.hexdigest(File.open(FilePool.path(fida)).read)
-      assert_equal Digest::MD5.hexdigest(File.open(@test_dir+"/b").read),
-                     Digest::MD5.hexdigest(File.open(FilePool.path(fidb)).read)
-      assert_equal Digest::MD5.hexdigest(File.open(@test_dir+"/c").read),
-                     Digest::MD5.hexdigest(File.open(FilePool.path(fidc)).read)
-      assert_equal Digest::MD5.hexdigest(File.open(@test_dir+"/d").read),
-                     Digest::MD5.hexdigest(File.open(FilePool.path(fidd)).read)
-
-      assert_equal Dir.tmpdir, File.dirname(FilePool.path(fida))
-      assert_equal Dir.tmpdir, File.dirname(FilePool.path(fidb))
-      assert_equal Dir.tmpdir, File.dirname(FilePool.path(fidc))
-      assert_equal Dir.tmpdir,File.dirname( FilePool.path(fidd))
-    end
-
-    should "remove files from encrypted pool" do
-
-      fidb = FilePool.add(@test_dir+"/b")
-      fidc = FilePool.add!(@test_dir+"/c")
-      fidd = FilePool.add!(@test_dir+"/d")
-
-      path_c = FilePool.path(fidc, :decrypt => false)
-      FilePool.remove(fidc)
-
-      assert !File.exist?(path_c)
-      assert File.exist?(FilePool.path(fidb, :decrypt => false))
-      assert File.exist?(FilePool.path(fidd, :decrypt => false))
-
-    end
-
-    should "throw exceptions when using add! and remove! on failure in encrypted mode" do
-      assert_raises(FilePool::InvalidFileId) do
-        FilePool.remove!("invalid-id")
-      end
-
-      assert_raises(Errno::ENOENT) do
-        FilePool.remove!("61e9b2d1-1738-440d-9b3d-e3c64876f2b0")
-      end
-
-      assert_raises(Errno::ENOENT) do
-        FilePool.add!("/not/here/foo.png")
-      end
-
-    end
-
-    should "not throw exceptions when using add and remove on failure in encrypted mode" do
-      assert !FilePool.remove("invalid-id")
-      assert !FilePool.remove("61e9b2d1-1738-440d-9b3d-e3c64876f2b0")
-      assert !FilePool.add("/not/here/foo.png")
-    end
-
-    should "detect whether file encrypted" do
-      fid = FilePool.add(@test_dir+"/a")
-      assert FilePool.encrypted?(fid)
-    end
-  end
-end