porky_lib 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99fe9eed54e08ab3c553aa2fb80256f6b7aaccac49fee918c1c12f713b93bef8
-  data.tar.gz: c3174d94c93b20e609b0058395893a5fa5a011e26df50acdc3727f4b7d9d73dd
+  metadata.gz: b1430e614f2d820b689e17b99735c4c7b24ba907640d427d2bd77c577e06017b
+  data.tar.gz: 278c2837a1a5eeefdb1ee584f69c07e448cad649777da8ac49fd51d477949b92
 SHA512:
-  metadata.gz: 20fc71c1519a16e5950d98a8437f8c08df4fbec90ede3a12247f5569005632b790b1f8de3a845ef96736e4202cf50724c4316e0aad24a545cf5a19f683cde925
-  data.tar.gz: d22574f96074ea36500af793b730cab786f9939ee62050c3d800823c789334109de6ad7f2fcda1e12b4b020bee40a16ccad71947cb8bb72083a18ae1af21b802
+  metadata.gz: 0b3499e0acf1bb5df6e6382d2eacb0fff863f1a3d493fe864fb25662c21c9cb27aae26fbc46c39fdca1a19ae54976d47e095a230dc5cbea66b66b5132e1edf51
+  data.tar.gz: d13230909d362eda803d787b1ff0fdcd3331bfa2672b9e4696f6d3e1128367317b32595bd56284dc2c81f22fd78b63107553ae3de1e7e3953601e933f10abc00

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    porky_lib (0.8.0)
+    porky_lib (0.9.0)
       aws-sdk-kms
       aws-sdk-s3
       msgpack
@@ -32,7 +32,7 @@ GEM
       bundler (>= 1.2.0, < 3)
       thor (~> 0.18)
     byebug (11.0.1)
-    codecov (0.1.14)
+    codecov (0.1.15)
       json
       simplecov
       url
@@ -44,10 +44,10 @@ GEM
     json (2.2.0)
     msgpack (1.3.1)
     parallel (1.17.0)
-    parser (2.6.3.0)
+    parser (2.6.4.1)
       ast (~> 2.4.0)
     rainbow (3.0.0)
-    rake (12.3.3)
+    rake (13.0.0)
     rbnacl (5.0.0)
       ffi
     rbnacl-libsodium (1.0.16)
@@ -56,11 +56,11 @@ GEM
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-collection_matchers (1.1.3)
+    rspec-collection_matchers (1.2.0)
       rspec-expectations (>= 2.99.0.beta1)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.1)
@@ -78,11 +78,11 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     rubocop-performance (1.4.1)
       rubocop (>= 0.71.0)
-    rubocop-rspec (1.35.0)
-      rubocop (>= 0.60.0)
+    rubocop-rspec (1.36.0)
+      rubocop (>= 0.68.1)
     rubocop_runner (2.2.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.17.0)
+    simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)

data/README.md

@@ -147,6 +147,13 @@ alias_exists = PorkyLib::Symmetric.instance.cmk_alias_exists?(key_alias)
 file_data = PorkyLib::FileService.read(bucket_name, file_key)
 ```
 
+### To Read Unencrypted Files From AWS S3
+```ruby
+# Where bucket_name is the name of the S3 bucket to read from
+# file_key is file identifier of the file/data that was written to S3.
+file_data = PorkyLib::Unencrypted::FileService.read(bucket_name, file_key)
+```
+
 ### To Write To AWS S3
 ```ruby
 # Where file is the data to encrypt and upload to S3 (can be raw data or path to a file on disk)
@@ -156,6 +163,14 @@ file_data = PorkyLib::FileService.read(bucket_name, file_key)
 file_key = PorkyLib::FileService.write(file, bucket_name, key_id, options)
 ```
 
+### To Write Unencrypted Files To AWS S3
+```ruby
+# Where file is the data to upload to S3 (can be raw data or path to a file on disk)
+# bucket_name is the name of the S3 bucket to write to
+# options is an optional parameter for specifying optional metadata about the file
+file_key = PorkyLib::Unencrypted::FileService.write(file, bucket_name, options)
+```
+
 ### Generate S3 Presigned POST URL
 To generate a new presigned POST url (used to upload files directly to AWS S3):
 ```ruby

data/lib/porky_lib.rb

@@ -5,4 +5,6 @@ module PorkyLib
   require 'porky_lib/file_service'
   require 'porky_lib/symmetric'
   require 'porky_lib/version'
+  require 'porky_lib/unencrypted'
+  require 'porky_lib/file_service_helper'
 end

data/lib/porky_lib/file_service.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require 'aws-sdk-s3'
 require 'singleton'
+require 'porky_lib/file_service_helper'
 
 class PorkyLib::FileService
   include Singleton
+  include FileServiceHelper
 
   class FileServiceError < StandardError; end
   class FileSizeTooLargeError < StandardError; end
@@ -59,7 +60,7 @@ class PorkyLib::FileService
     raise FileSizeTooLargeError, "File size is larger than maximum allowed size of #{max_file_size}" if file_size_invalid?(file)
 
     data = file_data(file)
-    file_key = options.key?(:directory) ? "#{options[:directory]}/#{SecureRandom.uuid}" : SecureRandom.uuid
+    file_key = generate_file_key(options)
     tempfile = encrypt_file_contents(data, key_id, file_key, options)
 
     begin
@@ -114,40 +115,6 @@ class PorkyLib::FileService
 
   private
 
-  def input_invalid?(file, bucket_name, key_id)
-    file.nil? || bucket_name.nil? || key_id.nil?
-  end
-
-  def file_size_invalid?(file)
-    file.bytesize > max_size || (File.file?(file) && File.size(file) > max_size)
-  end
-
-  def file_data(file)
-    File.file?(file) ? File.read(file) : file
-  end
-
-  def max_size
-    PorkyLib::Config.config[:max_file_size]
-  end
-
-  def max_file_size
-    {
-      B: 1024,
-      KB: 1024 * 1024,
-      MB: 1024 * 1024 * 1024,
-      GB: 1024 * 1024 * 1024 * 1024
-    }.each_pair { |symbol, bytes| return "#{(max_size.to_f / (bytes / 1024)).round(2)}#{symbol}" if max_size < bytes }
-  end
-
-  def perform_upload(bucket_name, file_key, tempfile, options)
-    obj = s3.bucket(bucket_name).object(file_key)
-    if options.key?(:metadata)
-      obj.upload_file(tempfile.path, metadata: options[:metadata])
-    else
-      obj.upload_file(tempfile.path)
-    end
-  end
-
   def decrypt_file_contents(tempfile)
     file_contents = tempfile.read
 
@@ -184,14 +151,6 @@ class PorkyLib::FileService
     }.to_json
   end
 
-  def write_tempfile(file_contents, file_key)
-    tempfile = Tempfile.new(file_key)
-    tempfile << file_contents
-    tempfile.close
-
-    tempfile
-  end
-
   def presign_url_expires_in
     PorkyLib::Config.config[:presign_url_expires_in]
   end
@@ -200,7 +159,7 @@ class PorkyLib::FileService
     @s3_client ||= Aws::S3::Client.new
   end
 
-  def s3
-    @s3 ||= Aws::S3::Resource.new
+  def input_invalid?(file, bucket_name, key_id)
+    file.nil? || bucket_name.nil? || key_id.nil?
   end
 end

data/lib/porky_lib/file_service_helper.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+
+module FileServiceHelper
+  def file_size_invalid?(file)
+    file.bytesize > max_size || (File.file?(file) && File.size(file) > max_size)
+  end
+
+  def file_data(file)
+    File.file?(file) ? File.read(file) : file
+  end
+
+  def write_tempfile(file_contents, file_key)
+    tempfile = Tempfile.new(file_key)
+    tempfile << file_contents
+    tempfile.close
+
+    tempfile
+  end
+
+  def perform_upload(bucket_name, file_key, tempfile, options)
+    obj = s3.bucket(bucket_name).object(file_key)
+    if options.key?(:metadata)
+      obj.upload_file(tempfile.path, metadata: options[:metadata])
+    else
+      obj.upload_file(tempfile.path)
+    end
+  end
+
+  def s3
+    @s3 ||= Aws::S3::Resource.new
+  end
+
+  def max_size
+    PorkyLib::Config.config[:max_file_size]
+  end
+
+  def max_file_size
+    {
+      B: 1024,
+      KB: 1024 * 1024,
+      MB: 1024 * 1024 * 1024,
+      GB: 1024 * 1024 * 1024 * 1024
+    }.each_pair { |symbol, bytes| return "#{(max_size.to_f / (bytes / 1024)).round(2)}#{symbol}" if max_size < bytes }
+  end
+
+  def generate_file_key(options)
+    options.key?(:directory) ? "#{options[:directory]}/#{SecureRandom.uuid}" : SecureRandom.uuid
+  end
+end

data/lib/porky_lib/unencrypted.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PorkyLib::Unencrypted
+  require 'porky_lib/unencrypted/file_service'
+end

data/lib/porky_lib/unencrypted/file_service.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'porky_lib/file_service_helper'
+
+class PorkyLib::Unencrypted::FileService
+  include Singleton
+  include FileServiceHelper
+
+  class FileServiceError < StandardError; end
+  class FileSizeTooLargeError < StandardError; end
+
+  def read(bucket_name, file_key, options = {})
+    tempfile = Tempfile.new
+
+    begin
+      object = s3.bucket(bucket_name).object(file_key)
+      raise FileSizeTooLargeError, "File size is larger than maximum allowed size of #{max_file_size}" if object.content_length > max_size
+
+      object.download_file(tempfile.path, options)
+    rescue Aws::Errors::ServiceError, Seahorse::Client::NetworkingError => e
+      raise FileServiceError, "Attempt to download a file from S3 failed.\n#{e.message}"
+    end
+
+    tempfile.read
+  end
+
+  def write(file, bucket_name, options = {})
+    raise FileServiceError, 'Invalid input. One or more input values is nil' if input_invalid?(file, bucket_name)
+    raise FileSizeTooLargeError, "File size is larger than maximum allowed size of #{max_file_size}" if file_size_invalid?(file)
+
+    file_key = generate_file_key(options)
+    tempfile = write_tempfile(file_data(file), file_key)
+
+    begin
+      perform_upload(bucket_name, file_key, tempfile, options)
+    rescue Aws::Errors::ServiceError, Seahorse::Client::NetworkingError => e
+      raise FileServiceError, "Attempt to upload a file to S3 failed.\n#{e.message}"
+    end
+
+    file_key
+  end
+
+  private
+
+  def input_invalid?(file, bucket_name)
+    file.nil? || bucket_name.nil?
+  end
+end

data/lib/porky_lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PorkyLib
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: porky_lib
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Greg Fletcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-12 00:00:00.000000000 Z
+date: 2019-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-kms
@@ -385,7 +385,10 @@ files:
 - lib/porky_lib/aws/kms/client.rb
 - lib/porky_lib/config.rb
 - lib/porky_lib/file_service.rb
+- lib/porky_lib/file_service_helper.rb
 - lib/porky_lib/symmetric.rb
+- lib/porky_lib/unencrypted.rb
+- lib/porky_lib/unencrypted/file_service.rb
 - lib/porky_lib/version.rb
 - porky_lib.gemspec
 homepage: https://github.com/Zetatango/porky_lib