defra_ruby_aws 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77814e6b155751f6f9008333ae24e48849522e3dc948ff983255a19534e29fc6
-  data.tar.gz: 551dd9f6bef0b52acdab49a6c7121627fb8fb6959ff119e6d3e00bf00dc292a9
+  metadata.gz: 1da7a16c3acdb14eb8690cdebe2586e93ec72acc9a93f3a4ad9f2f9ce315334c
+  data.tar.gz: 5a65b5bc761856abb099cbdf26da4335eba87d0afb443338e2529cfa6f30f863
 SHA512:
-  metadata.gz: d02db2c572ae6e19af365393ebc8e6d804b65d783e9ff80f72c2a820e8a2bc54443c6e4e32aeac9b32c8ec8057f8f106c1f4e5f249e1f95adc31c8023a87f8ef
-  data.tar.gz: bb0d956c1e085dd7c1ebb62d406fec5bc74938d8464c6f1a98698892086e5af6cae1a968e62f8d7b6bdbbbbf0e10fc3cd5ebb55b0d0b7952afcefa7864bb00aa
+  metadata.gz: 6f382ccf1699597d1040a9978eadf01c7e96c9b7fa1826dd8c2ac96f1bdd58f96286fe83809e8a9ab2be4cc4843e4db607d27290797270a758b47e4097830a81
+  data.tar.gz: 518b0337d6568a44c4fce640e4ebc0775147503dd78df1b2bafb79195ca708855c204ed843906d759ef0de9451f47dfb8026d975c8eb7007c8fc64855d2a652a

data/README.md

@@ -1,6 +1,6 @@
 # Defra Ruby Aws
 
-[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-aws.svg?branch=main)](https://travis-ci.com/DEFRA/defra-ruby-aws)
+![Build Status](https://github.com/DEFRA/defra-ruby-aws/workflows/CI/badge.svg?branch=main)
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-aws&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-aws)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-aws&metric=coverage)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-aws)
 [![security](https://hakiri.io/github/DEFRA/defra-ruby-aws/main.svg)](https://hakiri.io/github/DEFRA/defra-ruby-aws/main)
@@ -41,7 +41,9 @@ DefraRuby::Aws.configure do |config|
       secret_access_key: "SECRET_ACCESS_KEY"
     },
     # optional - Default to "eu-west-1"
-    region: "eu-west-1"
+    region: "eu-west-2",
+    # optional - Default to false. Will use AES256
+    encrypt_with_kms: true
   }]
 end
 ```
@@ -71,6 +73,7 @@ presigned_url = bucket.presigned_url("test-upload-file.csv")
 ```
 
 ### Delete a file from the bucket
+
 ```ruby
 bucket = DefraRuby::Aws.get_bucket("defra-ruby-aws")
 response = bucket.delete("test-upload-file.csv")
@@ -93,7 +96,7 @@ All contributions should be submitted via a pull request.
 
 THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
 
-http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+<http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3>
 
 The following attribution statement MUST be cited in your products and applications when using this information.
 

data/lib/defra_ruby/aws/bucket.rb

@@ -3,12 +3,13 @@
 module DefraRuby
   module Aws
     class Bucket
-      attr_reader :bucket_name, :credentials, :region
+      attr_reader :bucket_name, :credentials, :region, :encrypt_with_kms
 
       def initialize(configs)
         @credentials = configs[:credentials]
         @bucket_name = configs[:name]
         @region = setup_region(configs[:region])
+        @encrypt_with_kms = setup_encrypt_with_kms(configs[:encrypt_with_kms])
 
         validate!
       end
@@ -21,16 +22,24 @@ module DefraRuby
         credentials[:secret_access_key]
       end
 
-      def load(file)
-        BucketLoaderService.run(self, file)
+      def encryption_type
+        @_encryption_type ||= @encrypt_with_kms ? "aws:kms" : :AES256
       end
 
-      def presigned_url(file_name)
-        PresignedUrlService.run(self, file_name)
+      def load(file, options = {})
+        BucketLoaderService.run(self, file, options)
       end
 
-      def delete(file_name)
-        DeleteFileFromBucketService.run(self, file_name)
+      def presigned_url(file_name, options = {})
+        PresignedUrlService.run(self, file_name, options)
+      end
+
+      def delete(file_name, options = {})
+        DeleteFileFromBucketService.run(self, file_name, options)
+      end
+
+      def list_files(directory_name, options = {})
+        ListBucketFilesService.run(self, directory_name, options)
       end
 
       private
@@ -47,6 +56,14 @@ module DefraRuby
         "eu-west-1"
       end
 
+      def setup_encrypt_with_kms(encrypt_with_kms)
+        return false if encrypt_with_kms.nil?
+
+        # Handle the argument being either a string or a boolean, or some other
+        # value e.g. "foo"
+        encrypt_with_kms.to_s.downcase == "true"
+      end
+
       def validate!
         validate_presence_of_name!
         validate_presence_of_credentials!

data/lib/defra_ruby/aws/response.rb

@@ -5,11 +5,12 @@ module DefraRuby
     class UnsuccessfulOperation < StandardError; end
 
     class Response
-      attr_reader :error
+      attr_reader :error, :result
 
       def initialize(response_exe)
         @success = true
         @error = nil
+        @result = nil
 
         capture_response(response_exe)
       end
@@ -23,7 +24,8 @@ module DefraRuby
       attr_reader :success
 
       def capture_response(response_exe)
-        raise UnsuccessfulOperation unless response_exe.call
+        @result = response_exe.call
+        raise UnsuccessfulOperation unless @result
       rescue StandardError => e
         @error = e
         @success = false

data/lib/defra_ruby/aws/services/bucket_loader_service.rb

@@ -5,13 +5,14 @@ module DefraRuby
     class BucketLoaderService
       include HasAwsBucketConfiguration
 
-      def self.run(bucket, file)
-        new(bucket, file).run
+      def self.run(bucket, file, options = {})
+        new(bucket, file, options).run
       end
 
-      def initialize(bucket, file)
+      def initialize(bucket, file, options)
         @bucket = bucket
         @file = file
+        @dir = options[:s3_directory]
       end
 
       def run
@@ -20,13 +21,19 @@ module DefraRuby
 
       private
 
-      attr_reader :bucket, :file
+      attr_reader :bucket, :file, :dir
 
       def response_exe
         lambda do
-          s3_bucket.object(File.basename(file.path)).upload_file(file.path, server_side_encryption: "aws:kms")
+          s3_bucket
+            .object(destination)
+            .upload_file(file.path, server_side_encryption: bucket.encryption_type)
         end
       end
+
+      def destination
+        [*dir, File.basename(file.path)].compact.join("/")
+      end
     end
   end
 end

data/lib/defra_ruby/aws/services/delete_file_from_bucket_service.rb

@@ -5,13 +5,14 @@ module DefraRuby
     class DeleteFileFromBucketService
       include HasAwsBucketConfiguration
 
-      def self.run(bucket, file_name)
-        new(bucket, file_name).run
+      def self.run(bucket, file_name, options = {})
+        new(bucket, file_name, options).run
       end
 
-      def initialize(bucket, file_name)
+      def initialize(bucket, file_name, options)
         @bucket = bucket
         @file_name = file_name
+        @dir = options[:s3_directory]
       end
 
       def run
@@ -20,15 +21,19 @@ module DefraRuby
 
       private
 
-      attr_reader :bucket, :file_name
+      attr_reader :bucket, :file_name, :dir
 
       def response_exe
         lambda do
-          delete_object_output = s3_bucket.object(file_name).delete
+          delete_object_output = s3_bucket.object(destination).delete
 
           delete_object_output.request_charged.length.positive?
         end
       end
+
+      def destination
+        [*dir, file_name].compact.join("/")
+      end
     end
   end
 end

data/lib/defra_ruby/aws/services/list_bucket_files_service.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Aws
+    class ListBucketFilesService
+      include HasAwsBucketConfiguration
+
+      def self.run(bucket, folder, options = {})
+        new(bucket, folder, options).run
+      end
+
+      def initialize(bucket, folder, options)
+        @bucket = bucket
+        @folder = folder
+        @dir = options[:s3_directory]
+      end
+
+      def run
+        Response.new(response_exe)
+      end
+
+      private
+
+      attr_reader :bucket, :dir
+
+      def response_exe
+        lambda do
+          s3_bucket.objects(prefix: @folder).collect(&:key)
+        end
+      end
+    end
+  end
+end

data/lib/defra_ruby/aws/services/presigned_url_service.rb

@@ -5,17 +5,18 @@ module DefraRuby
     class PresignedUrlService
       include HasAwsBucketConfiguration
 
-      def self.run(bucket, file_name)
-        new(bucket, file_name).run
+      def self.run(bucket, file_name, options = {})
+        new(bucket, file_name, options).run
       end
 
-      def initialize(bucket, file_name)
+      def initialize(bucket, file_name, options)
         @bucket = bucket
         @file_name = file_name
+        @dir = options[:s3_directory]
       end
 
       def run
-        s3_bucket.object(file_name).presigned_url(
+        s3_bucket.object(destination).presigned_url(
           :get,
           expires_in: 20 * 60, # 20 minutes in seconds
           secure: true,
@@ -26,7 +27,11 @@ module DefraRuby
 
       private
 
-      attr_reader :bucket, :file_name
+      attr_reader :bucket, :file_name, :dir
+
+      def destination
+        [*dir, file_name].compact.join("/")
+      end
     end
   end
 end

data/lib/defra_ruby/aws/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Aws
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/defra_ruby/aws.rb

@@ -8,6 +8,7 @@ require_relative "aws/services/concerns/has_aws_bucket_configuration"
 require_relative "aws/services/bucket_loader_service"
 require_relative "aws/services/presigned_url_service"
 require_relative "aws/services/delete_file_from_bucket_service"
+require_relative "aws/services/list_bucket_files_service"
 
 module DefraRuby
   module Aws

data/spec/examples.txt

@@ -1,22 +1,48 @@
-example_id                                                                          | status | run_time        |
------------------------------------------------------------------------------------ | ------ | --------------- |
-./spec/defra_ruby_aws_spec.rb[1:1]                                                  | passed | 0.01013 seconds |
-./spec/features/upload_file_to_bucket_spec.rb[1:1]                                  | passed | 0.01626 seconds |
-./spec/features/upload_file_to_bucket_spec.rb[1:2]                                  | passed | 0.00509 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:1:1]                                   | passed | 0.00012 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:2:1]                                   | passed | 0.00011 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:3:1]                                   | passed | 0.00121 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:4:1]                                   | passed | 0.00011 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:2:1]                                     | passed | 0.0014 seconds  |
-./spec/lib/defra_ruby/aws/configuration_spec.rb[1:1:1]                              | passed | 0.00066 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:1:1:1]                                 | passed | 0.00017 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:1:2:1]                                 | passed | 0.00011 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:1:3:1]                                 | passed | 0.0025 seconds  |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:1:4:1]                                 | passed | 0.00013 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:1:5:1]                                 | passed | 0.00014 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:2:1:1]                                 | passed | 0.00088 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:2:2:1]                                 | passed | 0.0001 seconds  |
-./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:1]             | passed | 0.00061 seconds |
-./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:1]   | passed | 0.00875 seconds |
-./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:2:1] | passed | 0.00067 seconds |
-./spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb[1:1:1]             | passed | 0.00408 seconds |
+example_id                                                                            | status | run_time        |
+------------------------------------------------------------------------------------- | ------ | --------------- |
+./spec/defra_ruby_aws_spec.rb[1:1]                                                    | passed | 0.00115 seconds |
+./spec/features/upload_file_to_bucket_spec.rb[1:1]                                    | passed | 0.00635 seconds |
+./spec/features/upload_file_to_bucket_spec.rb[1:2]                                    | passed | 0.00572 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:1:1]                                     | passed | 0.00014 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:2:1]                                     | passed | 0.00012 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:3:1]                                     | passed | 0.00013 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:4:1]                                     | passed | 0.00174 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:5:1:1]                                   | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:5:2:1]                                   | passed | 0.0001 seconds  |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:6:1]                                     | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:1:1]                                   | passed | 0.00016 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:1:2]                                   | passed | 0.00012 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:2:1]                                   | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:2:2]                                   | passed | 0.00012 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:1:1]                                   | passed | 0.0001 seconds  |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:1:2]                                   | passed | 0.00012 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:2:1]                                   | passed | 0.00012 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:2:2]                                   | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:3:1]                                   | passed | 0.0001 seconds  |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:3:2]                                   | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:4:1]                                   | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:4:2]                                   | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:5:1]                                   | passed | 0.00012 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:5:2]                                   | passed | 0.0001 seconds  |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:2:1]                                       | passed | 0.00056 seconds |
+./spec/lib/defra_ruby/aws/configuration_spec.rb[1:1:1]                                | passed | 0.00058 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:1:1:1]                                   | passed | 0.00193 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:1:2:1]                                   | passed | 0.00015 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:1:3:1]                                   | passed | 0.0001 seconds  |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:1:4:1]                                   | passed | 0.00012 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:1:5:1]                                   | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:2:1:1]                                   | passed | 0.00066 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:3:1:1]                                   | passed | 0.0001 seconds  |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:3:2:1]                                   | passed | 0.00009 seconds |
+./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:1:1]             | passed | 0.00849 seconds |
+./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:1:2:1]           | passed | 0.00065 seconds |
+./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:2:1]             | passed | 0.0006 seconds  |
+./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:2:2:1]           | passed | 0.0006 seconds  |
+./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:1]     | passed | 0.00089 seconds |
+./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:2:1]   | passed | 0.00078 seconds |
+./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:3:1]   | passed | 0.00079 seconds |
+./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:3:2:1] | passed | 0.00077 seconds |
+./spec/lib/defra_ruby/aws/services/list_bucket_files_service_spec.rb[1:1:1:1]         | passed | 0.00247 seconds |
+./spec/lib/defra_ruby/aws/services/list_bucket_files_service_spec.rb[1:1:2:1]         | passed | 0.00093 seconds |
+./spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb[1:1:1]               | passed | 0.02254 seconds |
+./spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb[1:1:2:1]             | passed | 0.00314 seconds |

data/spec/lib/defra_ruby/aws/bucket_spec.rb

@@ -7,6 +7,8 @@ module DefraRuby
     RSpec.describe Bucket do
       subject(:bucket) { described_class.new(configs) }
 
+      let(:credentials) { { access_key_id: "access_key", secret_access_key: "secret" } }
+
       describe "#initialize" do
         context "when a name configuration is missing" do
           let(:configs) do
@@ -63,25 +65,175 @@ module DefraRuby
             expect { bucket }.to raise_error("DefraRuby::Aws buckets configurations: missing secret access key for bucket foo")
           end
         end
+
+        context "when 'region' is not set" do
+          context "because it has not been added to the config" do
+            let(:configs) do
+              {
+                name: "foo",
+                credentials: credentials
+              }
+            end
+
+            it "defaults the region to 'eu-west-1'" do
+              expect(bucket.region).to eq("eu-west-1")
+            end
+          end
+
+          context "because its value is an empty string" do
+            let(:configs) do
+              {
+                name: "foo",
+                credentials: credentials,
+                region: ""
+              }
+            end
+
+            it "defaults the region to 'eu-west-1'" do
+              expect(bucket.region).to eq("eu-west-1")
+            end
+          end
+        end
+
+        context "when 'region' is set" do
+          let(:region) { "eu-west-2" }
+          let(:configs) do
+            {
+              name: "foo",
+              credentials: credentials,
+              region: region
+            }
+          end
+
+          it "sets the region to match" do
+            expect(bucket.region).to eq(region)
+          end
+        end
+
+        context "when 'encrypt_with_kms' is not set" do
+          context "because it has not been added to the config" do
+            let(:configs) do
+              {
+                name: "foo",
+                credentials: credentials
+              }
+            end
+
+            it "defaults encrypt_with_kms to false" do
+              expect(bucket.encrypt_with_kms).to be false
+            end
+
+            it "sets encryption_type to :AES256" do
+              expect(bucket.encryption_type).to eq(:AES256)
+            end
+          end
+
+          context "because its value is an empty string" do
+            let(:configs) do
+              {
+                name: "foo",
+                credentials: credentials,
+                encrypt_with_kms: ""
+              }
+            end
+
+            it "defaults encrypt_with_kms to false" do
+              expect(bucket.encrypt_with_kms).to be false
+            end
+
+            it "sets encryption_type to :AES256" do
+              expect(bucket.encryption_type).to eq(:AES256)
+            end
+          end
+        end
+
+        context "when 'encrypt_with_kms' is set" do
+          let(:encrypt_with_kms) { true }
+          let(:configs) do
+            {
+              name: "foo",
+              credentials: credentials,
+              encrypt_with_kms: encrypt_with_kms
+            }
+          end
+
+          context "to true as a boolean" do
+            let(:encrypt_with_kms) { true }
+
+            it "defaults encrypt_with_kms to true" do
+              expect(bucket.encrypt_with_kms).to be true
+            end
+
+            it "sets encryption_type to aws:kms" do
+              expect(bucket.encryption_type).to eq("aws:kms")
+            end
+          end
+
+          context "to true as a string" do
+            let(:encrypt_with_kms) { "true" }
+
+            it "defaults encrypt_with_kms to true" do
+              expect(bucket.encrypt_with_kms).to be true
+            end
+
+            it "sets encryption_type to aws:kms" do
+              expect(bucket.encryption_type).to eq("aws:kms")
+            end
+          end
+
+          context "to false as a boolean" do
+            let(:encrypt_with_kms) { false }
+
+            it "defaults encrypt_with_kms to false" do
+              expect(bucket.encrypt_with_kms).to be false
+            end
+
+            it "sets encryption_type to aws:kms" do
+              expect(bucket.encryption_type).to eq(:AES256)
+            end
+          end
+
+          context "to false as a string" do
+            let(:encrypt_with_kms) { "false" }
+
+            it "defaults encrypt_with_kms to false" do
+              expect(bucket.encrypt_with_kms).to be false
+            end
+
+            it "sets encryption_type to aws:kms" do
+              expect(bucket.encryption_type).to eq(:AES256)
+            end
+          end
+
+          context "to something not recognised" do
+            let(:encrypt_with_kms) { "bar" }
+
+            it "defaults encrypt_with_kms to false" do
+              expect(bucket.encrypt_with_kms).to be false
+            end
+
+            it "sets encryption_type to :AES256" do
+              expect(bucket.encryption_type).to eq(:AES256)
+            end
+          end
+        end
       end
 
       describe "#load" do
         let(:configs) do
           {
             name: "foo",
-            credentials: {
-              secret_access_key: "secret",
-              access_key_id: "access_key"
-            }
+            credentials: credentials
           }
         end
 
         it "loads the given file to the s3 bucket" do
           result = double(:result)
           file = double(:file)
+          options = double(:options)
 
-          expect(BucketLoaderService).to receive(:run).with(bucket, file).and_return(result)
-          expect(bucket.load(file)).to eq(result)
+          expect(BucketLoaderService).to receive(:run).with(bucket, file, options).and_return(result)
+          expect(bucket.load(file, options)).to eq(result)
         end
       end
     end

data/spec/lib/defra_ruby/aws/response_spec.rb

@@ -49,6 +49,16 @@ module DefraRuby
         end
       end
 
+      describe "#result" do
+        context "when the response includes a result object" do
+          let(:response_exe) { -> { "I am an object" } }
+
+          it "returns the s3 result object" do
+            expect(described_class.new(response_exe).result).to eq "I am an object"
+          end
+        end
+      end
+
       describe "#error" do
         context "when the response throws an error" do
           let(:response_exe) { -> { raise StandardError, "Boom!" } }

data/spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb

@@ -5,31 +5,94 @@ require "spec_helper"
 module DefraRuby
   module Aws
     RSpec.describe BucketLoaderService do
+
       describe "#run" do
-        let(:configs) do
-          {
-            credentials: {
-              access_key_id: "key_id",
-              secret_access_key: "secret"
-            },
-            name: "bulk"
-          }
-        end
+        let(:credentials) { { access_key_id: "key_id", secret_access_key: "secret" } }
         let(:bucket) { Bucket.new(configs) }
 
-        it "loads the given file to the s3 bucket" do
-          aws_resource = double(:aws_resource)
-          s3_bucket = double(:s3_bulk_bucket)
-          file = double(:file, path: "foo/bar/baz/test.csv")
-          s3_object = double(:s3_object)
-          result = double(:result)
+        context "when 'encrypt_with_kms' is not set" do
+          let(:configs) do
+            {
+              credentials: credentials,
+              name: "bulk"
+            }
+          end
+
+          it "loads the given file to the s3 bucket using :AES256" do
+            aws_resource = double(:aws_resource)
+            s3_bucket = double(:s3_bulk_bucket)
+            file = double(:file, path: "foo/bar/baz/test.csv")
+            s3_object = double(:s3_object)
+            result = double(:result)
+
+            expect(::Aws::S3::Resource).to receive(:new).and_return(aws_resource)
+            expect(aws_resource).to receive(:bucket).with("bulk").and_return(s3_bucket)
+            expect(s3_bucket).to receive(:object).with("test.csv").and_return(s3_object)
+            expect(s3_object).to receive(:upload_file).with("foo/bar/baz/test.csv", server_side_encryption: :AES256).and_return(result)
+
+            expect(described_class.run(bucket, file)).to be_a(Response)
+          end
+
+          context "when an s3_directory is provided" do
+            it "loads the given file to the s3 bucket at the correct location using AWS:KMS" do
+              aws_resource = double(:aws_resource)
+              s3_bucket = double(:s3_bulk_bucket)
+              file = double(:file, path: "foo/bar/baz/test.csv")
+              s3_object = double(:s3_object)
+              result = double(:result)
+              options = { s3_directory: "directory" }
+
+              expect(::Aws::S3::Resource).to receive(:new).and_return(aws_resource)
+              expect(aws_resource).to receive(:bucket).with("bulk").and_return(s3_bucket)
+              expect(s3_bucket).to receive(:object).with("directory/test.csv").and_return(s3_object)
+              expect(s3_object).to receive(:upload_file).with("foo/bar/baz/test.csv", server_side_encryption: :AES256).and_return(result)
+
+              expect(described_class.run(bucket, file, options)).to be_a(Response)
+            end
+          end
+        end
+
+        context "when 'encrypt_with_kms' is set" do
+          let(:configs) do
+            {
+              credentials: credentials,
+              name: "bulk",
+              encrypt_with_kms: true
+            }
+          end
+
+          it "loads the given file to the s3 bucket using AWS:KMS" do
+            aws_resource = double(:aws_resource)
+            s3_bucket = double(:s3_bulk_bucket)
+            file = double(:file, path: "foo/bar/baz/test.csv")
+            s3_object = double(:s3_object)
+            result = double(:result)
+
+            expect(::Aws::S3::Resource).to receive(:new).and_return(aws_resource)
+            expect(aws_resource).to receive(:bucket).with("bulk").and_return(s3_bucket)
+            expect(s3_bucket).to receive(:object).with("test.csv").and_return(s3_object)
+            expect(s3_object).to receive(:upload_file).with("foo/bar/baz/test.csv", server_side_encryption: "aws:kms").and_return(result)
+
+            expect(described_class.run(bucket, file)).to be_a(Response)
+          end
+
+          context "when an s3_directory is provided" do
+            it "loads the given file to the s3 bucket at the correct location using AWS:KMS" do
+              aws_resource = double(:aws_resource)
+              s3_bucket = double(:s3_bulk_bucket)
+              file = double(:file, path: "foo/bar/baz/test.csv")
+              s3_object = double(:s3_object)
+              result = double(:result)
+              options = { s3_directory: %w[directory second_directory] }
 
-          expect(::Aws::S3::Resource).to receive(:new).and_return(aws_resource)
-          expect(aws_resource).to receive(:bucket).with("bulk").and_return(s3_bucket)
-          expect(s3_bucket).to receive(:object).with("test.csv").and_return(s3_object)
-          expect(s3_object).to receive(:upload_file).with("foo/bar/baz/test.csv", server_side_encryption: "aws:kms").and_return(result)
+              expect(::Aws::S3::Resource).to receive(:new).and_return(aws_resource)
+              expect(aws_resource).to receive(:bucket).with("bulk").and_return(s3_bucket)
+              expect(s3_bucket).to receive(:object).with("directory/second_directory/test.csv").and_return(s3_object)
+              expect(s3_object).to receive(:upload_file).with("foo/bar/baz/test.csv", server_side_encryption: "aws:kms").and_return(result)
 
-          expect(described_class.run(bucket, file)).to be_a(Response)
+              expect(described_class.run(bucket, file, options)).to be_a(Response)
+            end
+          end
         end
       end
     end

data/spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb

@@ -33,6 +33,25 @@ module DefraRuby
           expect(response).to be_successful
         end
 
+        context "when an s3_directory is provided" do
+          it "returns a successful response" do
+            aws_resource = double(:aws_resource)
+            s3_bucket = double(:s3_bulk_bucket)
+            file_name = "test.csv"
+            s3_object = double(:s3_object)
+            result = double(:result, request_charged: "present")
+            options = { s3_directory: "directory" }
+
+            expect(::Aws::S3::Resource).to receive(:new).and_return(aws_resource)
+            expect(aws_resource).to receive(:bucket).with("bulk").and_return(s3_bucket)
+            expect(s3_bucket).to receive(:object).with("directory/test.csv").and_return(s3_object)
+            expect(s3_object).to receive(:delete).and_return(result)
+
+            response = described_class.run(bucket, file_name, options)
+            expect(response).to be_successful
+          end
+        end
+
         context "when the response body returns an empty charged requests" do
           it "returns a non successful response" do
             aws_resource = double(:aws_resource)
@@ -49,6 +68,25 @@ module DefraRuby
             response = described_class.run(bucket, file_name)
             expect(response).to_not be_successful
           end
+
+          context "when an s3_directory is provided" do
+            it "returns a non successful response" do
+              aws_resource = double(:aws_resource)
+              s3_bucket = double(:s3_bulk_bucket)
+              file_name = "test.csv"
+              s3_object = double(:s3_object)
+              result = double(:result, request_charged: "")
+              options = { s3_directory: %w[directory second_directory] }
+
+              expect(::Aws::S3::Resource).to receive(:new).and_return(aws_resource)
+              expect(aws_resource).to receive(:bucket).with("bulk").and_return(s3_bucket)
+              expect(s3_bucket).to receive(:object).with("directory/second_directory/test.csv").and_return(s3_object)
+              expect(s3_object).to receive(:delete).and_return(result)
+
+              response = described_class.run(bucket, file_name, options)
+              expect(response).to_not be_successful
+            end
+          end
         end
       end
     end

data/spec/lib/defra_ruby/aws/services/list_bucket_files_service_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module DefraRuby
+  module Aws
+    RSpec.describe ListBucketFilesService do
+      describe "#run" do
+        let(:configs) do
+          {
+            credentials: {
+              access_key_id: "key_id",
+              secret_access_key: "secret"
+            },
+            name: "bulk"
+          }
+        end
+        let(:bucket) { Bucket.new(configs) }
+
+        context "when an s3_directory is provided" do
+          it "returns a successful response" do
+            aws_resource = double(:aws_resource)
+            s3_bucket = double(:s3_bulk_bucket)
+            s3_object1 = double(:s3_object)
+            s3_object2 = double(:s3_object)
+            s3_objects = [s3_object1, s3_object2]
+            s3_directory = "/a_directory"
+            options = {}
+
+            expect(::Aws::S3::Resource).to receive(:new).and_return(aws_resource)
+            expect(aws_resource).to receive(:bucket).with("bulk").and_return(s3_bucket)
+            expect(s3_bucket).to receive(:objects).with(prefix: s3_directory).and_return(s3_objects)
+            expect(s3_object1).to receive(:key).and_return("object1").at_least(:once)
+            expect(s3_object2).to receive(:key).and_return("object2").at_least(:once)
+
+            response = described_class.run(bucket, s3_directory, options)
+            expect(response).to be_successful
+            expect(response.result).to match_array([s3_object1.key, s3_object2.key])
+          end
+        end
+
+        context "when an s3_directory is not provided" do
+          it "returns a non successful response" do
+            aws_resource = double(:aws_resource)
+            s3_bucket = double(:s3_bulk_bucket)
+            s3_directory = nil
+
+            expect(::Aws::S3::Resource).to receive(:new).and_return(aws_resource)
+            expect(aws_resource).to receive(:bucket).with("bulk").and_return(s3_bucket)
+            expect(s3_bucket).to receive(:objects).with(prefix: s3_directory).and_return(nil)
+
+            response = described_class.run(bucket, s3_directory)
+            expect(response).to_not be_successful
+            expect(response.result).to be_nil
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb

@@ -26,6 +26,19 @@ module DefraRuby
           expect(presigned_url).to include("Amz-Credential")
           expect(presigned_url).to include("Amz-Signature")
         end
+
+        context "when an s3_directory is provided" do
+          let(:presigned_url) { described_class.run(bucket, "testfile.csv", { s3_directory: "directory" }) }
+
+          it "returns a presigned url for a given file in the bucket" do
+            expect(presigned_url).to include("https://test.s3.eu-west-1.amazonaws.com/directory/testfile.csv")
+            expect(presigned_url).to include("response-content-disposition=attachment")
+            expect(presigned_url).to include("response-content-type=text%2Fcsv")
+            expect(presigned_url).to include("Amz-Expires")
+            expect(presigned_url).to include("Amz-Credential")
+            expect(presigned_url).to include("Amz-Signature")
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_aws
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Defra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -155,6 +155,7 @@ files:
 - lib/defra_ruby/aws/services/bucket_loader_service.rb
 - lib/defra_ruby/aws/services/concerns/has_aws_bucket_configuration.rb
 - lib/defra_ruby/aws/services/delete_file_from_bucket_service.rb
+- lib/defra_ruby/aws/services/list_bucket_files_service.rb
 - lib/defra_ruby/aws/services/presigned_url_service.rb
 - lib/defra_ruby/aws/version.rb
 - spec/defra_ruby_aws_spec.rb
@@ -165,6 +166,7 @@ files:
 - spec/lib/defra_ruby/aws/response_spec.rb
 - spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb
 - spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb
+- spec/lib/defra_ruby/aws/services/list_bucket_files_service_spec.rb
 - spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/aws_sdk_s3.rb
@@ -178,7 +180,7 @@ licenses:
 - The Open Government Licence (OGL) Version 3
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,8 +195,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.0
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Defra ruby on rails AWS helpers
 test_files:
@@ -214,3 +216,4 @@ test_files:
 - spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb
 - spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb
 - spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb
+- spec/lib/defra_ruby/aws/services/list_bucket_files_service_spec.rb