porky_lib 0.9.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd1dfb255c5b91f06fe66af135ef84ef65fcb96bd02ad5150090619460bd7d86
-  data.tar.gz: 5edbf7d85795d8aaff798d486c043464199c03542c924f297559835796b9d829
+  metadata.gz: 70a7962acaef46a1b1e4cd9e1decaccbe5bb35867de03bbc8c4d24329f0ef4be
+  data.tar.gz: 81cbd165551dcafd6fb595e24a74af691143858bb3d8c9f70c4d8d1cb3d0a580
 SHA512:
-  metadata.gz: bc55b6280bce9d76a9d6553e239487f14712ba535fdf83c54006e6cd27c67e8babda30e58632fbf1d76f531bc8c822b96d34a1e0a5209cf4098f436567bd951d
-  data.tar.gz: 3e428d8b741ba820b43ef1dc891dd0cd2b3ae81d9b2ba0d578705c84296ade1c4b510eb69e706c8d5869e4153884f1af2a5cd1a22fed09e226a9d694134b6035
+  metadata.gz: f5fbc041473d83b4f4ad03321d3f30ba40990c139f215dc98a388c99999cb747415287a2c822bedb6f3dc2f71d37f1ceb72017ada14b65aba88584555ff448fb
+  data.tar.gz: 292725e636df669d3022edb4cd7f566b1b472b60dca17c1e8db1351c107ad06799e4b4b805425a5b58282b9c50bab57519033cf37e39286a3d71098474a5d0f3

data/.circleci/config.yml

@@ -3,10 +3,8 @@ jobs:
   build:
     parallelism: 1
     working_directory: ~/porky_lib
-    environment:
-      - CODECOV_TOKEN: 4d03ca51-5054-4858-87c7-b37c376ffb6a
     docker:
-      - image: circleci/ruby:2.6.5
+      - image: circleci/ruby:2.7.1
 
     steps:
       - checkout

data/.rubocop.yml

@@ -9,7 +9,8 @@ AllCops:
     - node_modules/**/*
     - output/**/*
     - vendor/**/*
-  TargetRubyVersion: 2.3.7
+    - spec/porky_lib/data/*
+  TargetRubyVersion: 2.7.1
   RSpec:
     Patterns:
       - _spec.rb
@@ -17,10 +18,22 @@ AllCops:
     SpecTypes:
       Feature: 'spec/features/**/*'
 
-Documentation:
+Style/Documentation:
   Enabled: false
 
-Metrics/LineLength:
+Security/MarshalLoad:
+  Enabled: true
+
+Security/Eval:
+  Enabled: true
+
+Security/YAMLLoad:
+  Enabled: true
+
+Security/JSONLoad:
+  Enabled: true
+
+Layout/LineLength:
   Max: 160
 
 Metrics/ClassLength:
@@ -46,3 +59,45 @@ RSpec/MultipleExpectations:
 
 RSpec/ExampleLength:
   Max: 10
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-ruby '2.6.5'
+ruby '2.7.1'
 
 source "https://rubygems.org"
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    porky_lib (0.9.2)
+    porky_lib (0.11.0)
       aws-sdk-kms
       aws-sdk-s3
       msgpack
@@ -11,85 +11,91 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    aws-eventstream (1.0.3)
-    aws-partitions (1.228.0)
-    aws-sdk-core (3.72.0)
-      aws-eventstream (~> 1.0, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.228.0)
+    ast (2.4.1)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.338.0)
+    aws-sdk-core (3.103.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.25.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-kms (1.36.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.51.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-s3 (1.73.0)
+      aws-sdk-core (~> 3, >= 3.102.1)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.1.0)
-      aws-eventstream (~> 1.0, >= 1.0.2)
-    bundler-audit (0.6.1)
+    aws-sigv4 (1.2.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+    bundler-audit (0.7.0.1)
       bundler (>= 1.2.0, < 3)
-      thor (~> 0.18)
-    byebug (11.0.1)
-    codecov (0.1.15)
+      thor (>= 0.18, < 2)
+    byebug (11.1.3)
+    codacy-coverage (2.2.1)
+      simplecov
+    codecov (0.1.17)
       json
       simplecov
       url
     diff-lcs (1.3)
     docile (1.3.2)
-    ffi (1.10.0)
-    jaro_winkler (1.5.3)
+    ffi (1.12.2)
     jmespath (1.4.0)
-    json (2.2.0)
-    msgpack (1.3.1)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
+    json (2.3.0)
+    msgpack (1.3.3)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.0)
+    rake (13.0.1)
     rbnacl (5.0.0)
       ffi
     rbnacl-libsodium (1.0.16)
       rbnacl (>= 3.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
     rspec-collection_matchers (1.2.0)
       rspec-expectations (>= 2.99.0.beta1)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
     rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+    rspec-support (3.9.3)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.75.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.86.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
       rubocop (>= 0.71.0)
-    rubocop-rspec (1.36.0)
+    rubocop-rspec (1.40.0)
       rubocop (>= 0.68.1)
     rubocop_runner (2.2.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thor (0.20.3)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thor (1.0.1)
     timecop (0.9.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
     url (0.3.2)
 
 PLATFORMS
@@ -101,6 +107,7 @@ DEPENDENCIES
   bundler
   bundler-audit
   byebug
+  codacy-coverage
   codecov
   msgpack
   porky_lib!
@@ -119,7 +126,7 @@ DEPENDENCIES
   timecop
 
 RUBY VERSION
-   ruby 2.6.5p114
+   ruby 2.7.1p83
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -20,7 +20,7 @@ And then execute:
 Or install it yourself as:
 
     $ gem install porky_lib
-    
+
 Inside of your Ruby program do:
 
 ```ruby
@@ -86,7 +86,7 @@ To encrypt data with a known plaintext key:
 # plaintext_key is the encryption key to use
 # encryption_info is the structure returned that contains:
 #   ciphertext: plaintext encrypted under plaintext_key
-#   nonce: The generated nonce 
+#   nonce: The generated nonce
 encryption_info = PorkyLib::Symmetric.instance.encrypt_with_key(plaintext, plaintext_key)
 ```
 
@@ -104,7 +104,7 @@ To decrypt data with a known plaintext key:
 ```ruby
 # Where ciphertext is the encrypted data to be decrypted
 # plaintext_key is the decryption key to use
-# nonce is the nonce to use 
+# nonce is the nonce to use
 # decryption_info is the structured returned that contains:
 #   plaintext: ciphertext decrypted under plaintext_key
 decryption_info = PorkyLib::Symmetric.instance.decrypt_with_key(ciphertext, plaintext_key, nonce)
@@ -137,7 +137,7 @@ plaintext_key.replace(PorkyLib::Symmetric.instance.secure_delete_plaintext_key(p
 To verify whether an alias exists or not:
 ```ruby
 # Where key_alias is the alias name to verify
-alias_exists = PorkyLib::Symmetric.instance.cmk_alias_exists?(key_alias) 
+alias_exists = PorkyLib::Symmetric.instance.cmk_alias_exists?(key_alias)
 ```
 
 ### To Read From AWS S3
@@ -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
+# options is an optional parameter for specifying optional metadata about the file and the storage_class of the object
 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 upload to S3 (can be raw data or ruby file object)
+# 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
+# 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 and the storage_class of the object
+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 and the storage_class of the object
+file_key = PorkyLib::FileService.write_data(data, bucket_name, key_id, options)
+```
+
+### To Write Unencrypted To AWS S3
+```ruby
+# --- 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 and the storage_class of the object
 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 and the storage_class of the object
+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 and the storage_class of the object
+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
@@ -188,12 +224,84 @@ To generate a new presigned GET url (used to download files directly from AWS S3
 url = PorkyLib::Symmetric.instance.presigned_get_url(bucket_name, file_key)
 ```
 
+## Rake task
+If you want to write or read an encrypted file from the command line, there is a Rake write and read task.
+
+> Note: the environment variables can be set globally or by prepending them to the rake task command
+
+### Write file
+
+Rake task name: `file:write`
+
+Environment variables:
+* Required
+  * `FILE_PATH` - Absolute or relative file path
+  * `CMK_KEY_ID` - Alias of the CMK key
+  * `AWS_S3_BUCKET` - AWS S3 bucket name
+  * `AWS_REGION` - AWS region name
+  * `AWS_ACCESS_KEY_ID` - AWS access key ID (credentials)
+  * `AWS_ACCESS_KEY` - AWS secret access key (credentials)
+* Optional
+  * `AWS_S3_MOCK_CLIENT` - PorkyLib's AWS KMS mock client (defaults to `true`)
+  * `AWS_S3_MAX_FILE_SIZE` - Max file size (defaults to `1MB`)
+  * `AWS_S3_STORAGE_CLASS` - One of STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE (defaults to `STANDARD`)
+  * `AWS_S3_KEEP_FILE_NAME` - Saves the file in AWS S3 with the original file name (defaults to `true`)
+
+### Read file
+
+Rake task name: `file:read`
+
+Environment variables:
+* Required
+  * `FILE_KEY` - AWS S3 object file key
+  * `AWS_S3_BUCKET` - AWS S3 bucket name
+  * `AWS_REGION` - AWS region name
+  * `AWS_ACCESS_KEY_ID` - AWS access key ID (credentials)
+  * `AWS_ACCESS_KEY` - AWS secret access key (credentials)
+* Optional
+  * `AWS_S3_MOCK_CLIENT` - PorkyLib's AWS KMS mock client (defaults to `true`)
+  * `AWS_S3_MAX_FILE_SIZE` - Max file size (defaults to `1MB`)
+  * `DESTINATION` - Location to save the file (defaults to `FILE_KEY`)
+
 ## Development
 
 Development on this project should occur on separate feature branches and pull requests should be submitted. When submitting a
 pull request, the pull request comment template should be filled out as much as possible to ensure a quick review and increase
 the likelihood of the pull request being accepted.
 
+### Ruby
+
+This application requires:
+
+*   Ruby version: 2.7.1
+
+Ruby 2.7.1 and greater requires OpenSSL 1.1+. To link to Homebrew's upgraded version of OpenSSL, add the following to your bash profile
+
+```shell script
+export RUBY_CONFIGURE_OPTS="--with-openssl-dir=$(brew --prefix openssl@1.1)"
+```
+
+If you do not have Ruby installed, it is recommended you use ruby-install and chruby to manage Ruby versions.
+
+```bash
+brew install ruby-install chruby
+ruby-install ruby 2.7.1
+```
+
+Add the following lines to ~/.bash_profile:
+
+```bash
+source /usr/local/opt/chruby/share/chruby/chruby.sh
+source /usr/local/opt/chruby/share/chruby/auto.sh
+```
+
+Set Ruby version to 2.7.1:
+
+```bash
+source ~/.bash_profile
+chruby 2.7.1
+```
+
 ### Running Tests
 
 ```ruby

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+import 'lib/tasks/file.rake'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/porky_lib/aws/kms/client.rb

@@ -72,7 +72,7 @@ class Aws::KMS::Client
 
   def decrypt(ciphertext_blob:, encryption_context: nil)
     key_id, decoded_context, plaintext = MessagePack.unpack(ciphertext_blob.reverse)
-    decoded_context = Hash[decoded_context.map { |k, v| [k.to_sym, v] }] if decoded_context
+    decoded_context = decoded_context.transform_keys(&:to_sym) if decoded_context
     raise Aws::KMS::Errors::InvalidCiphertextException.new(nil, nil) unless decoded_context == encryption_context
 
     Aws::KMS::Types::DecryptResponse.new(

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,10 +58,30 @@ 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)
-    file_key = generate_file_key(options)
+    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 = if options.key?(:file_name)
+                 options[:file_name]
+               else
+                 generate_file_key(options)
+               end
     tempfile = encrypt_file_contents(data, key_id, file_key, options)
 
     begin
@@ -73,12 +95,12 @@ class PorkyLib::FileService
     file_key
   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)
+  def overwrite_file(data, file_key, bucket_name, key_id, options = {})
+    raise FileServiceError, 'Invalid input. One or more input values is nil' if overwrite_input_invalid?(data, 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
@@ -158,7 +180,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,18 @@
 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
-    else
-      file_or_content.bytesize > max_size
-    end
+  extend Gem::Deprecate
+
+  class FileServiceError < StandardError; end
+
+  def data_size_invalid?(data)
+    data.bytesize > max_size
   end
 
-  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,13 +24,25 @@ 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)
-      obj.upload_file(tempfile.path, metadata: options[:metadata])
-    else
-      obj.upload_file(tempfile.path)
-    end
+
+    upload_options = {
+      metadata: (options[:metadata] if options.key?(:metadata)),
+      storage_class: (options[:storage_class] if options.key?(:storage_class))
+    }.compact
+
+    obj.upload_file(tempfile.path, upload_options)
   end
 
   def s3
@@ -58,4 +71,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,31 @@ 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)
 
-    file_key = generate_file_key(options)
-    tempfile = write_tempfile(file_data(file), file_key)
+    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 = if options.key?(:file_name)
+                 options[:file_name]
+               else
+                 generate_file_key(options)
+               end
+    tempfile = write_tempfile(data, file_key)
 
     begin
       perform_upload(bucket_name, file_key, tempfile, options)
@@ -42,7 +65,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.11.0"
 end

data/lib/tasks/file.rake

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'porky_lib'
+
+namespace :file do
+  desc "Read a file from AWS S3"
+  task :read do
+    # Optional arguments
+    use_mock_client = ENV.fetch('AWS_S3_MOCK_CLIENT', 'true') == 'true'
+    max_file_size = ENV.fetch('AWS_S3_MAX_FILE_SIZE', 1_048_576).to_i
+    destination = ENV.fetch('DESTINATION', ENV['FILE_KEY'])
+
+    # Required arguments
+    arguments = {
+      file_key: ENV['FILE_KEY'],
+      aws_s3_bucket: ENV['AWS_S3_BUCKET'],
+      aws_region: ENV['AWS_REGION'],
+      aws_access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+      aws_access_key: ENV['AWS_ACCESS_KEY']
+    }
+
+    # Checks presence of required arguments and configures porky_lib
+    check_arguments(arguments)
+    setup_porky_lib(arguments, use_mock_client, max_file_size)
+
+    # Reads and writes the file
+    message, = PorkyLib::FileService.instance.read(arguments[:aws_s3_bucket], arguments[:file_key])
+    file = File.open(destination, 'w')
+    file.puts(message)
+    file.close
+
+    puts "SUCCESS - Saved file: '#{destination}' with content of the bucket: '#{arguments[:aws_s3_bucket]}' with file_key: '#{arguments[:file_key]}'"
+  end
+
+  desc "Write a file to AWS S3"
+  task :write do
+    # Optional arguments
+    use_mock_client = ENV.fetch('AWS_S3_MOCK_CLIENT', 'true') == 'true'
+    max_file_size = ENV.fetch('AWS_S3_MAX_FILE_SIZE', 1_048_576).to_i
+    storage_class = ENV.fetch('AWS_S3_STORAGE_CLASS', 'STANDARD')
+    keep_file_name = ENV.fetch('AWS_S3_KEEP_FILE_NAME', 'true') == 'true'
+
+    # Required arguments
+    arguments = {
+      file_path: ENV['FILE_PATH'],
+      cmk_key_id: ENV['CMK_KEY_ID'],
+      aws_s3_bucket: ENV['AWS_S3_BUCKET'],
+      aws_region: ENV['AWS_REGION'],
+      aws_access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+      aws_access_key: ENV['AWS_ACCESS_KEY']
+    }
+
+    # Checks presence of required arguments and configures porky_lib
+    check_arguments(arguments)
+    setup_porky_lib(arguments, use_mock_client, max_file_size)
+
+    write_options = {
+      storage_class: storage_class,
+      file_name: (File.basename(arguments[:file_path]) if keep_file_name)
+    }.compact
+
+    # Creates CMK key with empty tags and stores file
+    PorkyLib::Symmetric.instance.create_key([{}], arguments[:cmk_key_id]) unless PorkyLib::Symmetric.instance.cmk_alias_exists?(arguments[:cmk_key_id])
+    file_key = PorkyLib::FileService.instance.write_file(arguments[:file_path], arguments[:aws_s3_bucket], arguments[:cmk_key_id], write_options)
+
+    puts "SUCCESS - Created file: '#{arguments[:file_path]}' bucket: '#{arguments[:aws_s3_bucket]}' file_key: '#{file_key}'"
+  end
+end
+
+private
+
+def check_arguments(arguments)
+  nil_arguments = []
+  arguments.map { |key, value| nil_arguments.push(key.to_s.upcase) if value.nil? && !key.nil? }
+  abort "ERROR - Need to provide as environment variables: #{nil_arguments.join(', ')}" unless nil_arguments.empty?
+end
+
+def setup_porky_lib(arguments, use_mock_client, max_file_size)
+  PorkyLib::Config.configure(aws_region: arguments[:aws_region],
+                             aws_key_id: arguments[:aws_access_key_id],
+                             aws_key_secret: arguments[:aws_access_key],
+                             aws_client_mock: use_mock_client,
+                             max_file_size: max_file_size)
+  PorkyLib::Config.initialize_aws
+end

data/porky_lib.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'bundler-audit'
   spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'codacy-coverage'
   spec.add_development_dependency 'codecov'
   spec.add_development_dependency 'msgpack'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: porky_lib
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Greg Fletcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-kms
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codacy-coverage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -390,6 +404,7 @@ files:
 - lib/porky_lib/unencrypted.rb
 - lib/porky_lib/unencrypted/file_service.rb
 - lib/porky_lib/version.rb
+- lib/tasks/file.rake
 - porky_lib.gemspec
 homepage: https://github.com/Zetatango/porky_lib
 licenses: []
@@ -409,7 +424,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A library for cryptographic services using AWS KMS and RbNaCl