file-manager 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3274b9402d808285bad4ecb41f687666157135f7
-  data.tar.gz: a5d16438c16799c45c76d8b7633fe9dcaf1a5732
+SHA256:
+  metadata.gz: f13f65293d73d3c2a9579e931eece74f25a71dade78f8683c18225d421bdd325
+  data.tar.gz: a4e2a80b4b11d894129f39a843ed1304e197a2b2e92d66f8bbffc7dfefd30306
 SHA512:
-  metadata.gz: cc14c2b86c76e173319127c7562902044b4a8355478594f63c515b8b2f7d67095b2d11744a65d75745fb188c9d9a5adeec106f176b14f2039079268a8766374c
-  data.tar.gz: 2ae8c3f919f1620b4f41d949a2b35b8b3cfac1ae247a01631f29626a4dde91532414d73ca33ea6b702bf098b19608f1715c1ebb40ab777ec277f1d824d25d70d
+  metadata.gz: c4034f8b52e6a0d28219fb97fc7912889193967d84930fd8cfa96a800a175c5f7d27271d6a403cf924fe947b30e1e0ccd97334945be70110357c1de5a08508c4
+  data.tar.gz: 3e04ef0a2d74bcb42ce53618b6e4188e446e28297aa343601d82adb9e1befe256fbafa56b205bcc435b761f66ca2c1871bef8a6fc85ba48dbefcf8cc2853a0f7

data/.travis.yml

@@ -1,8 +1,13 @@
 language: ruby
+env:
+  - JRUBY_OPTS=--debug
 rvm:
-  - 2.2.1
-  - jruby-19mode
+  - 2.5.3
+  - jruby-9.2.5.0
   - ruby-head
   - jruby-head
 jdk:
-  - openjdk7
+  - openjdk8
+before_install:
+  - gem update --system
+  - gem --version

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in file-manager.gemspec
 gemspec
+
+group :test do
+  gem 'single_cov', require: false
+end

data/Gemfile.lock

@@ -1,54 +1,55 @@
 PATH
   remote: .
   specs:
-    file-manager (0.2.0)
-      aws-sdk (= 2.2.13)
+    file-manager (0.7.0)
+      aws-sdk-s3 (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.4.0)
-    aws-sdk (2.2.13)
-      aws-sdk-resources (= 2.2.13)
-    aws-sdk-core (2.2.13)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.394.0)
+    aws-sdk-core (3.109.3)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.2.13)
-      aws-sdk-core (= 2.2.13)
-    codeclimate-test-reporter (0.4.8)
-      simplecov (>= 0.7.1, < 1.0.0)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    docile (1.1.5)
-    hashdiff (0.2.3)
-    jmespath (1.1.3)
-    json (1.8.3)
-    json (1.8.3-java)
-    minitest (5.8.4)
-    rake (10.5.0)
-    safe_yaml (1.0.4)
-    simplecov (0.11.1)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    vcr (3.0.1)
-    webmock (1.22.6)
+    aws-sdk-kms (1.39.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.84.1)
+      aws-sdk-core (~> 3, >= 3.109.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    crack (0.4.4)
+    hashdiff (1.0.1)
+    jmespath (1.4.0)
+    minitest (5.14.2)
+    public_suffix (4.0.6)
+    rake (13.0.1)
+    single_cov (1.6.0)
+    vcr (6.0.0)
+    webmock (3.9.5)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
-  codeclimate-test-reporter
+  bundler (>= 1.16.2)
   file-manager!
   minitest
   rake
+  single_cov
   vcr
   webmock
 
 BUNDLED WITH
-   1.10.6
+   2.0.1

data/README.md

@@ -1,4 +1,7 @@
-# File::Manager [![Build Status](https://travis-ci.org/fortesinformatica/file-manager.svg?branch=master)](https://travis-ci.org/fortesinformatica/file-manager) [![Code Climate](https://codeclimate.com/github/fortesinformatica/file-manager/badges/gpa.svg)](https://codeclimate.com/github/fortesinformatica/file-manager) [![Test Coverage](https://codeclimate.com/github/fortesinformatica/file-manager/badges/coverage.svg)](https://codeclimate.com/github/fortesinformatica/file-manager) [![Dependency Status](https://gemnasium.com/fortesinformatica/file-manager.svg)](https://gemnasium.com/fortesinformatica/file-manager)
+# File::Manager
+
+[![Build Status](https://travis-ci.org/fortesinformatica/file-manager.svg?branch=master)](https://travis-ci.org/fortesinformatica/file-manager)
+[![Code Climate](https://codeclimate.com/github/fortesinformatica/file-manager/badges/gpa.svg)](https://codeclimate.com/github/fortesinformatica/file-manager)
 
 File manager local or S3
 
@@ -37,6 +40,14 @@ file_manager_txt = factory.create(:txt)
 
 file_manager_txt.save_file('babau.txt', 'buuuu')
 
+## Testing
+
+```sh
+export AWS_ACCESS_KEY_ID='' # with your keys
+export AWS_SECRET_ACCESS_KEY=''
+bundle exec rake
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -4,6 +4,7 @@ require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
+  t.warning = false
 end
 
 desc 'Run tests'

data/file-manager.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "file-manager"
-  spec.version       = '0.2.0'
+  spec.version       = '0.7.0'
   spec.authors       = ["Francisco Barroso / Marlus Saraiva"]
   spec.email         = ["franciscobarroso@grupofortes.com.br"]
   spec.description   = 'File manager, access S3 or local'
@@ -16,11 +16,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.homepage    = 'https://github.com/fortesinformatica/file-manager'
 
-  spec.add_dependency 'aws-sdk', '2.2.13'
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_dependency 'aws-sdk-s3', '~> 1'
+  spec.add_development_dependency "bundler", ">= 1.16.2"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/file_manager.rb

@@ -15,6 +15,10 @@ class FileManager
     raise 'Not implemented!'
   end
 
+  def download_to_temp_file(file_name)
+    raise 'Not implemented!'
+  end
+
   def list_files(prefix = '', file_extension = '*')
     raise 'Not implemented!'
   end

data/lib/local_file_manager.rb

@@ -23,6 +23,19 @@ class LocalFileManager < FileManager
     @logger.puts 'done.'
   end
 
+  def download_to_temp_file(file_name)
+    @logger.print "Copying local file \"#{file_name}\" to folder \"#{root_path}\"..."
+    full_file_name = Pathname(File.join(root_path, file_name))
+    Dir.mktmpdir do |dir|
+      temp_file = "#{dir}/#{full_file_name.basename}"
+      FileUtils.cp(full_file_name, temp_file)
+      yield(temp_file)
+    end
+    @logger.puts 'done.'
+  rescue Errno::ENOENT
+    raise FileNotFoundError.new(full_file_name)
+  end
+
   def list_files(prefix = '', file_extension = '*')
     FileUtils.mkdir_p(root_path)
     @logger.print "Listing \"#{prefix}*.#{file_extension}\" from local folder \"#{root_path}\"..."
@@ -37,8 +50,30 @@ class LocalFileManager < FileManager
   def delete_file file_name
     @logger.print "Deleting file \"#{file_name}\" from local folder \"#{root_path}\"..."
     full_file_name = File.join(root_path, file_name)
-    File.delete(full_file_name) if File.exists?(full_file_name)
+    File.delete(full_file_name) if File.exist?(full_file_name)
+    @logger.puts 'done.'
+  end
+
+  def rename_file original_file_name, target_file_name
+    @logger.print "Renaming file \"#{original_file_name}\" to \"#{target_file_name}\" from local folder \"#{root_path}\"..."
+    full_original_file_name = File.join(root_path, original_file_name)
+    full_target_file_name = Pathname(File.join(root_path, target_file_name))
+    FileUtils.mkdir_p(full_target_file_name.dirname)
+    FileUtils.mv full_original_file_name, full_target_file_name
     @logger.puts 'done.'
+  rescue Errno::ENOENT
+    raise FileNotFoundError.new(full_original_file_name)
+  end
+
+  def copy_file source_file_name, target_file_name
+    @logger.print "Copying file \"#{source_file_name}\" to \"#{target_file_name}\" from local folder \"#{root_path}\"..."
+    full_source_file_name = File.join(root_path, source_file_name)
+    full_target_file_name = Pathname(File.join(root_path, target_file_name))
+    FileUtils.mkdir_p(full_target_file_name.dirname)
+    FileUtils.cp full_source_file_name, full_target_file_name
+    @logger.puts 'done.'
+  rescue Errno::ENOENT
+    raise FileNotFoundError.new(full_source_file_name)
   end
 
   private

data/lib/memory_file_manager.rb

@@ -16,6 +16,10 @@ class MemoryFileManager < FileManager
   end
 
   def list_files(prefix = '', file_extension = '*')
+    if prefix == '' && file_extension == '*'
+      return @data.keys
+    end
+
     @data.keys.select{|key| key.start_with?(prefix) && key.end_with?(".#{file_extension}")}
   end
 
@@ -23,4 +27,21 @@ class MemoryFileManager < FileManager
     @data.delete "#{file_name}"
   end
 
+  def download_to_temp_file(file_name)
+    Dir.mktmpdir do |dir|
+      temp_file = "#{dir}/#{Pathname(file_name).basename}"
+      content = read_file(file_name)
+      File.open(temp_file, 'w') { |file| file.write(content) }
+      yield(temp_file)
+    end
+  end
+
+  def rename_file original_file_name, target_file_name
+    @data["#{target_file_name}"] = @data["#{original_file_name}"] || (raise FileNotFoundError.new("No such file '#{original_file_name}'"))
+    @data.delete "#{original_file_name}"
+  end
+
+  def copy_file source_file_name, target_file_name
+    @data["#{target_file_name}"] = @data["#{source_file_name}"] || (raise FileNotFoundError.new("No such file '#{source_file_name}'"))
+  end
 end

data/lib/s3_file_manager.rb

@@ -1,5 +1,5 @@
 require 'file_manager'
-require 'aws-sdk'
+require 'aws-sdk-s3'
 
 class S3FileManager < FileManager
 
@@ -30,6 +30,21 @@ class S3FileManager < FileManager
     logger.puts 'done.'
   end
 
+  def download_to_temp_file(file_name)
+    Dir.mktmpdir do |dir|
+      @logger.print "Downloading file \"#{bucket_name}/#{file_name}\" to temp folder \"#{dir}\"..."
+      temp_file = "#{dir}/#{Pathname(file_name).basename}"
+
+      s3_client = connect_s3_client
+      s3_client.get_object({ bucket: bucket_name, key: file_name }, target: temp_file)
+
+      yield(temp_file)
+    end
+    logger.puts 'done.'
+  rescue Aws::S3::Errors::NoSuchKey
+    raise FileNotFoundError.new("#{bucket_name}/#{file_name}")
+  end
+
   def list_files(prefix = '', file_extension = '*')
     # objects = []
     # last_key = nil
@@ -67,6 +82,26 @@ class S3FileManager < FileManager
     logger.puts 'done.'
   end
 
+  def rename_file original_file_name, target_file_name
+    s3_service = connect_s3_service
+    bucket = s3_service.bucket(bucket_name)
+    logger.print "Renaming file \"#{original_file_name}\" \"#{target_file_name}\" from bucket \"#{bucket_name}\"..."
+    bucket.object(original_file_name).move_to(bucket: bucket_name, key: target_file_name)
+    logger.puts 'done.'
+  rescue Aws::S3::Errors::NoSuchKey
+    raise FileNotFoundError.new("#{bucket_name}/#{original_file_name}")
+  end
+
+  def copy_file source_file_name, target_file_name
+    s3_service = connect_s3_service
+    bucket = s3_service.bucket(bucket_name)
+    logger.print "Copying file \"#{source_file_name}\" \"#{target_file_name}\" from bucket \"#{bucket_name}\"..."
+    bucket.object(source_file_name).copy_to(bucket: bucket_name, key: target_file_name)
+    logger.puts 'done.'
+  rescue Aws::S3::Errors::NoSuchKey
+    raise FileNotFoundError.new("#{bucket_name}/#{source_file_name}")
+  end
+
   private
 
   def connect_s3_service
@@ -80,4 +115,9 @@ class S3FileManager < FileManager
     service
   end
 
+  def connect_s3_client
+    credentials = Aws::Credentials.new(options[:access_key_id], options[:secret_access_key])
+    Aws::S3::Client.new(region: options[:region], credentials: credentials)
+  end
+
 end

data/test/coverage_test.rb

@@ -0,0 +1,15 @@
+require './test/test_helper'
+SingleCov.not_covered! # not testing any code in lib/
+
+class CoverageTest < Minitest::Test
+  def test_for_untested_code
+    # option :tests to pass custom Dir.glob results
+    SingleCov.assert_used
+  end
+
+  def test_for_untested_files
+    # option :tests and :files to pass custom Dir.glob results
+    # :untested to get it passing with known untested files
+    SingleCov.assert_tested untested: %w[lib/file_manager_factory.rb]
+  end
+end

data/test/file_manager_test.rb

@@ -1,6 +1,8 @@
 require './test/test_helper'
 require 'memory_file_manager'
 
+SingleCov.covered! uncovered: 5
+
 module FileManagerTest
   def test_reading
     assert_raises(FileNotFoundError) { @manager.read_file 'not_saved' }
@@ -48,8 +50,68 @@ module FileManagerTest
     assert_empty @manager.list_files
   end
 
+
   def test_remove_not_existing_file_dont_raise
     assert_empty @manager.list_files
     @manager.delete_file 'sub_dir/saved.*'
   end
+
+  def test_downloading_to_temp_file
+    @manager.save_file 'temp_file/saved', 'content'
+    assert_equal 'content', @manager.read_file('temp_file/saved')
+
+    @manager.download_to_temp_file('temp_file/saved') do |temp_file|
+      contents = File.open(temp_file) { |f| f.read }
+      assert_equal contents, 'content'
+    end
+
+    @manager.delete_file 'temp_file/saved'
+    assert_raises(FileNotFoundError) { @manager.download_to_temp_file('temp_file/saved') {} }
+  end
+
+  def test_rename_file
+    assert_empty @manager.list_files
+    @manager.save_file 'original/name.txt', 'rename_content'
+
+    @manager.rename_file 'original/name.txt', 'new/name.txt'
+    assert_equal ['new/name.txt'], @manager.list_files
+    assert_equal 'rename_content', @manager.read_file('new/name.txt')
+
+    @manager.rename_file 'new/name.txt', 'new/new2/name.txt'
+    assert_equal ['new/new2/name.txt'], @manager.list_files
+    assert_equal 'rename_content', @manager.read_file('new/new2/name.txt')
+
+    assert_raises(FileNotFoundError) { @manager.rename_file 'nao_existe/name.txt', 'new/name.txt' }
+  ensure
+    @manager.delete_file 'original/name.txt'
+    @manager.delete_file 'new/new2/name.txt'
+    assert_empty @manager.list_files
+  end
+
+  def test_copy_file
+    assert_empty @manager.list_files
+    @manager.save_file 'original/name.txt', 'same_content'
+
+    @manager.copy_file 'original/name.txt', 'new/name.txt'
+    assert_equal ['new/name.txt', 'original/name.txt'].sort, @manager.list_files.sort
+    assert_equal 'same_content', @manager.read_file('new/name.txt')
+
+    @manager.copy_file 'original/name.txt', 'new/name.txt'
+    assert_equal ['new/name.txt', 'original/name.txt'].sort, @manager.list_files.sort
+
+    assert_raises(FileNotFoundError) { @manager.copy_file 'nao_existe/name.txt', 'new/name.txt' }
+  ensure
+    @manager.delete_file 'original/name.txt'
+    @manager.delete_file 'new/name.txt'
+    assert_empty @manager.list_files
+  end
+end
+
+class FileManagerLoggerTest < Minitest::Test
+
+  def test_logger_prints_and_puts
+    logger = FileManager::Logger.new({})
+    assert_output("hello\n") { logger.puts "hello" }
+    assert_output("hi") { logger.print "hi" }
+  end
 end

data/test/{local_test.rb → local_file_manager_test.rb}

@@ -1,5 +1,8 @@
 require './test/test_helper'
 require 'local_file_manager'
+require_relative 'file_manager_test'
+
+SingleCov.covered!
 
 class LocalFileManagerTest < Minitest::Test
   include FileManagerTest