porky_lib 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c98aaa41950874c7b37f159230db8356e526dec8f35a2a7d9c5fbe9d1f484a21
-  data.tar.gz: 5997f378160b2b05cd176c44b25570374159cbaafa7d8f83e1eb8c52014d7ca6
+  metadata.gz: 99fe9eed54e08ab3c553aa2fb80256f6b7aaccac49fee918c1c12f713b93bef8
+  data.tar.gz: c3174d94c93b20e609b0058395893a5fa5a011e26df50acdc3727f4b7d9d73dd
 SHA512:
-  metadata.gz: 2bbcd43825926a03d5382cefad9ff6053a83117aaf163a12bd6e5a0502d595ce4b2167be745e1417e4d019e88df9f1a8c6e0e2a9266c5273245534c34d83cac2
-  data.tar.gz: 93dbfb9406f2773017fac22946eba097405945181cc3bf26762f222dff1c1a27538c04eec9006aecb626a201357df11fe7073bd4a023a39fc97e458caec8d13d
+  metadata.gz: 20fc71c1519a16e5950d98a8437f8c08df4fbec90ede3a12247f5569005632b790b1f8de3a845ef96736e4202cf50724c4316e0aad24a545cf5a19f683cde925
+  data.tar.gz: d22574f96074ea36500af793b730cab786f9939ee62050c3d800823c789334109de6ad7f2fcda1e12b4b020bee40a16ccad71947cb8bb72083a18ae1af21b802

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    porky_lib (0.7.0)
+    porky_lib (0.8.0)
       aws-sdk-kms
       aws-sdk-s3
       msgpack

data/README.md

@@ -35,10 +35,14 @@ Something like the following should be included in an initializer in your Rails
 ```ruby
 # Use PorkyLib's AWS KMS mock client except in production, for example
 use_mock_client = !Rails.env.production?
+max_file_size = 0 # max file size allowed, in bytes - defaults to 0
+presign_url_expires_in = 300 # expiry time for presigned urls, in seconds - defaults to 300 (5 minutes)
 PorkyLib::Config.configure(aws_region: ENV[AWS_REGION],
                            aws_key_id: ENV[AWS_KEY_ID],
                            aws_key_secret: ENV[AWS_KEY_SECRET],
-                           aws_client_mock: use_mock_client)
+                           aws_client_mock: use_mock_client,
+                           max_file_size: max_file_size,
+                           presign_url_expires_in: presign_url_expires_in)
 PorkyLib::Config.initialize_aws
 ```
 
@@ -152,6 +156,23 @@ file_data = PorkyLib::FileService.read(bucket_name, file_key)
 file_key = PorkyLib::FileService.write(file, bucket_name, key_id, options)
 ```
 
+### Generate S3 Presigned POST URL
+To generate a new presigned POST url (used to upload files directly to AWS S3):
+```ruby
+# Where 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 is randomly generated, unless it's passed as a parameter in the options hash using 'file_name' as key
+url, file_key = PorkyLib::Symmetric.instance.presigned_post_url(bucket_name, options)
+```
+
+### Generate S3 Presigned GET URL
+To generate a new presigned GET url (used to download files directly from AWS S3):
+```ruby
+# Where bucket_name is the name of the S3 bucket to read from
+# file_key is the file identifier of the file/data that was written to S3.
+url = PorkyLib::Symmetric.instance.presigned_get_url(bucket_name, file_key)
+```
+
 ## Development
 
 Development on this project should occur on separate feature branches and pull requests should be submitted. When submitting a

data/lib/porky_lib/config.rb

@@ -6,13 +6,15 @@ class PorkyLib::Config
   @aws_key_secret = ''
   @aws_client_mock = false
   @max_file_size = 0
+  @presign_url_expires_in = 300 # 5 minutes
 
   @config = {
     aws_region: @aws_region,
     aws_key_id: @aws_key_id,
     aws_key_secret: @aws_key_secret,
     aws_client_mock: @aws_client_mock,
-    max_file_size: @max_file_size
+    max_file_size: @max_file_size,
+    presign_url_expires_in: @presign_url_expires_in
   }
 
   @allowed_config_keys = @config.keys

data/lib/porky_lib/file_service.rb

@@ -91,6 +91,27 @@ class PorkyLib::FileService
     tempfile.unlink
   end
 
+  def presigned_post_url(bucket_name, options = {})
+    file_name = options[:file_name] || SecureRandom.uuid
+    obj = s3.bucket(bucket_name).object(file_name)
+
+    presigned_url = obj.presigned_url(:put,
+                                      expires_in: presign_url_expires_in,
+                                      metadata: options[:metadata])
+    [presigned_url, file_name]
+  rescue Aws::Errors::ServiceError => e
+    raise FileServiceError, "PresignedPostUrl for #{file_name} from S3 bucket #{bucket_name} failed: #{e.message}"
+  end
+
+  def presigned_get_url(bucket_name, file_key)
+    obj = s3.bucket(bucket_name).object(file_key)
+
+    obj.presigned_url(:get,
+                      expires_in: presign_url_expires_in)
+  rescue Aws::Errors::ServiceError => e
+    raise FileServiceError, "PresignedGetUrl for #{file_key} from S3 bucket #{bucket_name} failed: #{e.message}"
+  end
+
   private
 
   def input_invalid?(file, bucket_name, key_id)
@@ -171,6 +192,10 @@ class PorkyLib::FileService
     tempfile
   end
 
+  def presign_url_expires_in
+    PorkyLib::Config.config[:presign_url_expires_in]
+  end
+
   def s3_client
     @s3_client ||= Aws::S3::Client.new
   end

data/lib/porky_lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: porky_lib
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Greg Fletcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-kms