defra_ruby_aws 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e35f8c64d2e528faf5a59987c833be7a8c53c5a68694fe842f042ae1ec174f82
-  data.tar.gz: acadc8305a896c1895f7cdbba00cb0e3181e9caf0693b31c89b5f06d141b5e3d
+  metadata.gz: 1da7a16c3acdb14eb8690cdebe2586e93ec72acc9a93f3a4ad9f2f9ce315334c
+  data.tar.gz: 5a65b5bc761856abb099cbdf26da4335eba87d0afb443338e2529cfa6f30f863
 SHA512:
-  metadata.gz: dfc64c44e01e4f61df59a018aeba7054c34ca061a60406b17e41267467689df4bc0d5c1496eed445ec823cbdbf1b8cce8aafec25935b175ad5a5df9f52c564e5
-  data.tar.gz: 5113bbd9312b32f23a6a0b725d64cf94c73714ae1c8e03675166f2b7f8679a95032478f38373970b23f85db04b0e448099aadc6590362509dbc7b20fb1972349
+  metadata.gz: 6f382ccf1699597d1040a9978eadf01c7e96c9b7fa1826dd8c2ac96f1bdd58f96286fe83809e8a9ab2be4cc4843e4db607d27290797270a758b47e4097830a81
+  data.tar.gz: 518b0337d6568a44c4fce640e4ebc0775147503dd78df1b2bafb79195ca708855c204ed843906d759ef0de9451f47dfb8026d975c8eb7007c8fc64855d2a652a

data/lib/defra_ruby/aws/bucket.rb

@@ -38,6 +38,10 @@ module DefraRuby
         DeleteFileFromBucketService.run(self, file_name, options)
       end
 
+      def list_files(directory_name, options = {})
+        ListBucketFilesService.run(self, directory_name, options)
+      end
+
       private
 
       attr_writer :region

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/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/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Aws
-    VERSION = "0.4.1"
+    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,45 +1,48 @@
 example_id                                                                            | status | run_time        |
 ------------------------------------------------------------------------------------- | ------ | --------------- |
-./spec/defra_ruby_aws_spec.rb[1:1]                                                    | passed | 0.00091 seconds |
-./spec/features/upload_file_to_bucket_spec.rb[1:1]                                    | passed | 0.00642 seconds |
-./spec/features/upload_file_to_bucket_spec.rb[1:2]                                    | passed | 0.0188 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.0001 seconds  |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:3:1]                                     | passed | 0.0001 seconds  |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:4:1]                                     | passed | 0.00099 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:5:1:1]                                   | passed | 0.00014 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:5:2:1]                                   | passed | 0.00008 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:6:1]                                     | passed | 0.00008 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:1:1]                                   | passed | 0.00007 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:1:2]                                   | passed | 0.00013 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:2:1]                                   | passed | 0.0001 seconds  |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:2:2]                                   | passed | 0.00009 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:1:1]                                   | passed | 0.00018 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:1:2]                                   | passed | 0.0001 seconds  |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:2:1]                                   | passed | 0.00009 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:2:2]                                   | passed | 0.00017 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:3:1]                                   | passed | 0.00023 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:3:2]                                   | passed | 0.00014 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:4:1]                                   | passed | 0.0002 seconds  |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:4:2]                                   | passed | 0.0001 seconds  |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:5:1]                                   | passed | 0.00071 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:5:2]                                   | passed | 0.00019 seconds |
-./spec/lib/defra_ruby/aws/bucket_spec.rb[1:2:1]                                       | passed | 0.00092 seconds |
-./spec/lib/defra_ruby/aws/configuration_spec.rb[1:1:1]                                | passed | 0.00064 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:1:1:1]                                   | passed | 0.00021 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:1:2:1]                                   | passed | 0.00012 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:1:3:1]                                   | passed | 0.00012 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.00015 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:2:1:1]                                   | passed | 0.00062 seconds |
-./spec/lib/defra_ruby/aws/response_spec.rb[1:2:2:1]                                   | passed | 0.00012 seconds |
-./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:1:1]             | passed | 0.00088 seconds |
-./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:1:2:1]           | passed | 0.00072 seconds |
-./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:2:1]             | passed | 0.00076 seconds |
-./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:2:2:1]           | passed | 0.00239 seconds |
-./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:1]     | passed | 0.00676 seconds |
-./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:2:1]   | passed | 0.00064 seconds |
-./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:3:1]   | passed | 0.00069 seconds |
-./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:3:2:1] | passed | 0.00059 seconds |
-./spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb[1:1:1]               | passed | 0.01032 seconds |
-./spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb[1:1:2:1]             | passed | 0.00982 seconds |
+./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/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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_aws
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Defra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-07 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
@@ -194,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+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