porky_lib 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd1dfb255c5b91f06fe66af135ef84ef65fcb96bd02ad5150090619460bd7d86
-  data.tar.gz: 5edbf7d85795d8aaff798d486c043464199c03542c924f297559835796b9d829
+  metadata.gz: 63d12d040a5b5f4c6b96940a29bd3ff771e713327fa7269488ea731b76fb59aa
+  data.tar.gz: a086399a4c16939060522f80e0e1421268781973ffd15e7fac42dfece572782a
 SHA512:
-  metadata.gz: bc55b6280bce9d76a9d6553e239487f14712ba535fdf83c54006e6cd27c67e8babda30e58632fbf1d76f531bc8c822b96d34a1e0a5209cf4098f436567bd951d
-  data.tar.gz: 3e428d8b741ba820b43ef1dc891dd0cd2b3ae81d9b2ba0d578705c84296ade1c4b510eb69e706c8d5869e4153884f1af2a5cd1a22fed09e226a9d694134b6035
+  metadata.gz: cd5e4418205489c4705648c575d23011a139eac1622202e638b3bb20a0a8e753996601b52be9ba05cf4148f3e1b8779b944c7fb87f0c8af834a1c42554b99c8e
+  data.tar.gz: 29b4c3e1243a851e61b2a288666dcd98a6f1d6f4f892a4f250cc0d3edcaf81562a19202dc016dce201b2cb2a0c92df2fe601f8cb64ab822ceb2e04aadcfbb505

data/.rubocop.yml

@@ -9,6 +9,7 @@ AllCops:
     - node_modules/**/*
     - output/**/*
     - vendor/**/*
+    - spec/porky_lib/data/*
   TargetRubyVersion: 2.3.7
   RSpec:
     Patterns:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    porky_lib (0.9.2)
+    porky_lib (0.9.3)
       aws-sdk-kms
       aws-sdk-s3
       msgpack
@@ -13,8 +13,8 @@ GEM
   specs:
     ast (2.4.0)
     aws-eventstream (1.0.3)
-    aws-partitions (1.228.0)
-    aws-sdk-core (3.72.0)
+    aws-partitions (1.232.0)
+    aws-sdk-core (3.72.1)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1, >= 1.228.0)
       aws-sigv4 (~> 1.1)
@@ -22,7 +22,7 @@ GEM
     aws-sdk-kms (1.25.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.51.0)
+    aws-sdk-s3 (1.53.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
@@ -32,7 +32,7 @@ GEM
       bundler (>= 1.2.0, < 3)
       thor (~> 0.18)
     byebug (11.0.1)
-    codecov (0.1.15)
+    codecov (0.1.16)
       json
       simplecov
       url
@@ -69,7 +69,7 @@ GEM
     rspec-support (3.9.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.75.1)
+    rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)

data/README.md

@@ -156,21 +156,57 @@ 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 ruby file object)
+# --- DEPRECATED --- Please use write_data or write_file instead of write
+# Where file is the data to encrypt and upload to S3 (can be a path or raw data or ruby file object)
 # bucket_name is the name of the S3 bucket to write to
 # key_id is the ID of the CMK to use to generate a data encryption key to encrypt the file data
 # options is an optional parameter for specifying optional metadata about the file
 file_key = PorkyLib::FileService.write(file, bucket_name, key_id, options)
 ```
 
-### To Write Unencrypted Files To AWS S3
+### To Write Files To AWS S3
+```ruby
+# Where file is the data to encrypt and upload to S3 (can be a path or ruby file object)
+# bucket_name is the name of the S3 bucket to write to
+# key_id is the ID of the CMK to use to generate a data encryption key to encrypt the file data
+# options is an optional parameter for specifying optional metadata about the file
+file_key = PorkyLib::FileService.write_file(file, bucket_name, key_id, options)
+```
+
+### To Write Data To AWS S3
+```ruby
+# Where data is the raw data to encrypt and upload to S3
+# bucket_name is the name of the S3 bucket to write to
+# key_id is the ID of the CMK to use to generate a data encryption key to encrypt the file data
+# options is an optional parameter for specifying optional metadata about the file
+file_key = PorkyLib::FileService.write_data(data, bucket_name, key_id, options)
+```
+
+### To Write Unencrypted To AWS S3
 ```ruby
-# Where file is the data to upload to S3 (can be raw data or ruby file object)
+# --- DEPRECATED --- Please use write_data or write_file instead of write
+# Where file is the data to upload to S3 (can be a path or raw data or ruby file object)
 # 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)
 ```
 
+### To Write Unencrypted Files To AWS S3
+```ruby
+# Where file is the data to encrypt and upload to S3 (can be a path or ruby file object)
+# 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(file, bucket_name, options)
+```
+
+### To Write Unencrypted Data To AWS S3
+```ruby
+# Where data is the raw data to encrypt and upload to S3
+# 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_data(data, 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/file_service.rb

@@ -3,6 +3,8 @@
 require 'singleton'
 
 class PorkyLib::FileService
+  extend Gem::Deprecate
+
   include Singleton
   include PorkyLib::FileServiceHelper
 
@@ -56,9 +58,25 @@ class PorkyLib::FileService
 
   def write(file, bucket_name, key_id, options = {})
     raise FileServiceError, 'Invalid input. One or more input values is nil' if input_invalid?(file, bucket_name, key_id)
-    raise FileSizeTooLargeError, "File size is larger than maximum allowed size of #{max_file_size}" if file_size_invalid?(file)
 
-    data = file_data(file)
+    if file?(file)
+      write_file(file, bucket_name, key_id, options)
+    else
+      write_data(file, bucket_name, key_id, options)
+    end
+  end
+  deprecate :write, 'write_file or write_data', 2020, 1
+
+  def write_file(file, bucket_name, key_id, options = {})
+    raise FileServiceError, 'Invalid input. One or more input values is nil' if input_invalid?(file, bucket_name, key_id)
+
+    write_data(read_file(file), bucket_name, key_id, options)
+  end
+
+  def write_data(data, bucket_name, key_id, options = {})
+    raise FileServiceError, 'Invalid input. One or more input values is nil' if input_invalid?(data, bucket_name, key_id)
+    raise FileSizeTooLargeError, "Data size is larger than maximum allowed size of #{max_file_size}" if data_size_invalid?(data)
+
     file_key = generate_file_key(options)
     tempfile = encrypt_file_contents(data, key_id, file_key, options)
 
@@ -74,11 +92,12 @@ class PorkyLib::FileService
   end
 
   def overwrite_file(file, file_key, bucket_name, key_id, options = {})
-    raise FileServiceError, 'Invalid input. One or more input values is nil' if input_invalid?(file, bucket_name, key_id)
+    raise FileServiceError, 'Invalid input. One or more input values is nil' if overwrite_input_invalid?(file, file_key, bucket_name, key_id)
     raise FileServiceError, 'Invalid input. file_key cannot be nil if overwriting an existing file' if file_key.nil?
-    raise FileSizeTooLargeError, "File size is larger than maximum allowed size of #{max_file_size}" if file_size_invalid?(file)
 
     data = file_data(file)
+    raise FileSizeTooLargeError, "File size is larger than maximum allowed size of #{max_file_size}" if data_size_invalid?(data)
+
     tempfile = encrypt_file_contents(data, key_id, file_key, options)
 
     begin
@@ -90,6 +109,7 @@ class PorkyLib::FileService
     # Remove tempfile from disk
     tempfile.unlink
   end
+  deprecate :overwrite_file, :none, 2020, 0o1
 
   def presigned_post_url(bucket_name, options = {})
     file_name = options[:file_name] || SecureRandom.uuid
@@ -158,7 +178,11 @@ class PorkyLib::FileService
     @s3_client ||= Aws::S3::Client.new
   end
 
-  def input_invalid?(file, bucket_name, key_id)
-    file.nil? || bucket_name.nil? || key_id.nil?
+  def input_invalid?(file_or_data, bucket_name, key_id)
+    file_or_data.nil? || bucket_name.nil? || key_id.nil?
+  end
+
+  def overwrite_input_invalid?(file_or_data, file_key, bucket_name, key_id)
+    file_or_data.nil? || file_key.nil? || bucket_name.nil? || key_id.nil?
   end
 end

data/lib/porky_lib/file_service_helper.rb

@@ -3,17 +3,27 @@
 require 'aws-sdk-s3'
 
 module PorkyLib::FileServiceHelper
-  def file_size_invalid?(file_or_content)
-    if a_file?(file_or_content)
-      File.size(file_or_content) > max_size
+  extend Gem::Deprecate
+
+  class FileServiceError < StandardError; end
+
+  def data_size_invalid?(data)
+    data.bytesize > max_size
+  end
+
+  def file_data(file_or_content)
+    if file?(file_or_content)
+      read_file(file_or_content)
     else
-      file_or_content.bytesize > max_size
+      file_or_content
     end
   end
+  deprecate :file_data, :none, 2020, 1
 
-  def file_data(file_or_content)
-    a_file?(file_or_content) ? File.read(file_or_content) : file_or_content
+  def file?(file_or_content)
+    a_file?(file_or_content) || a_path?(file_or_content)
   end
+  deprecate :file?, :none, 2020, 1
 
   def write_tempfile(file_contents, file_key)
     tempfile = Tempfile.new(file_key)
@@ -23,6 +33,16 @@ module PorkyLib::FileServiceHelper
     tempfile
   end
 
+  def read_file(file)
+    raise FileServiceError, 'file cannot be nil' if file.nil?
+    return file if !a_file?(file) && contain_null_byte?(file)
+    raise FileServiceError, 'The specified file does not exist' unless File.file?(file)
+
+    File.read(file)
+  rescue Errno::EACCES
+    raise FileServiceError, 'The specified file cannot be read, no permissions'
+  end
+
   def perform_upload(bucket_name, file_key, tempfile, options)
     obj = s3.bucket(bucket_name).object(file_key)
     if options.key?(:metadata)
@@ -58,4 +78,17 @@ module PorkyLib::FileServiceHelper
   def a_file?(file_or_content)
     !file_or_content.is_a?(String)
   end
+
+  def a_path?(content_or_path)
+    return false if contain_null_byte?(content_or_path)
+
+    File.file?(content_or_path)
+  end
+
+  def contain_null_byte?(data)
+    null_byte = (+"\u0000").force_encoding("ASCII-8BIT")
+    data = (+data).force_encoding("ASCII-8BIT")
+
+    data.include?(null_byte)
+  end
 end

data/lib/porky_lib/unencrypted/file_service.rb

@@ -3,6 +3,8 @@
 require 'singleton'
 
 class PorkyLib::Unencrypted::FileService
+  extend Gem::Deprecate
+
   include Singleton
   include PorkyLib::FileServiceHelper
 
@@ -26,10 +28,27 @@ class PorkyLib::Unencrypted::FileService
 
   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)
+
+    if file?(file)
+      write_file(file, bucket_name, options)
+    else
+      write_data(file, bucket_name, options)
+    end
+  end
+  deprecate :write, 'write_file or write_data', 2020, 1
+
+  def write_file(file, bucket_name, options = {})
+    raise FileServiceError, 'Invalid input. One or more input values is nil' if input_invalid?(file, bucket_name)
+
+    write_data(read_file(file), bucket_name, options)
+  end
+
+  def write_data(data, bucket_name, options = {})
+    raise FileServiceError, 'Invalid input. One or more input values is nil' if input_invalid?(data, bucket_name)
+    raise FileSizeTooLargeError, "Data size is larger than maximum allowed size of #{max_file_size}" if data_size_invalid?(data)
 
     file_key = generate_file_key(options)
-    tempfile = write_tempfile(file_data(file), file_key)
+    tempfile = write_tempfile(data, file_key)
 
     begin
       perform_upload(bucket_name, file_key, tempfile, options)
@@ -42,7 +61,7 @@ class PorkyLib::Unencrypted::FileService
 
   private
 
-  def input_invalid?(file, bucket_name)
-    file.nil? || bucket_name.nil?
+  def input_invalid?(file_or_data, bucket_name)
+    file_or_data.nil? || bucket_name.nil?
   end
 end

data/lib/porky_lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: porky_lib
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Greg Fletcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2019-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-kms