defra_ruby_aws 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77814e6b155751f6f9008333ae24e48849522e3dc948ff983255a19534e29fc6
-  data.tar.gz: 551dd9f6bef0b52acdab49a6c7121627fb8fb6959ff119e6d3e00bf00dc292a9
+  metadata.gz: 7f0d5054fbb79afd158de9df8f72a117b757369315a0d66c06ee3664e14e906a
+  data.tar.gz: e41c2a7d8583c2b9e4d0835586074048f9d78d1bb0eb0829c04f7c5e1a189e04
 SHA512:
-  metadata.gz: d02db2c572ae6e19af365393ebc8e6d804b65d783e9ff80f72c2a820e8a2bc54443c6e4e32aeac9b32c8ec8057f8f106c1f4e5f249e1f95adc31c8023a87f8ef
-  data.tar.gz: bb0d956c1e085dd7c1ebb62d406fec5bc74938d8464c6f1a98698892086e5af6cae1a968e62f8d7b6bdbbbbf0e10fc3cd5ebb55b0d0b7952afcefa7864bb00aa
+  metadata.gz: 2955c3c540c3885b6ad13a1f05663ad80bc41dabbe088dceeb2500a1275f80072d237e68eceef863131f1d238142b848b35c38dc5cd58a8e888795cbd1ecb8e6
+  data.tar.gz: 1911659d171b1c4d0dd83702977527457bca619b90b37903a2b15a625ba02d1d91bb31fc20be3934e266885602ddb1245383a4453fce6bae6bb37c5167cd4354

data/README.md

@@ -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,6 +22,10 @@ module DefraRuby
         credentials[:secret_access_key]
       end
 
+      def encryption_type
+        @_encryption_type ||= @encrypt_with_kms ? "aws:kms" : :AES256
+      end
+
       def load(file)
         BucketLoaderService.run(self, file)
       end
@@ -47,6 +52,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/services/bucket_loader_service.rb

@@ -24,7 +24,9 @@ module DefraRuby
 
       def response_exe
         lambda do
-          s3_bucket.object(File.basename(file.path)).upload_file(file.path, server_side_encryption: "aws:kms")
+          s3_bucket
+            .object(File.basename(file.path))
+            .upload_file(file.path, server_side_encryption: bucket.encryption_type)
         end
       end
     end

data/lib/defra_ruby/aws/version.rb

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

data/spec/examples.txt

@@ -1,22 +1,40 @@
 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/defra_ruby_aws_spec.rb[1:1]                                                  | passed | 0.00095 seconds |
+./spec/features/upload_file_to_bucket_spec.rb[1:1]                                  | passed | 0.01317 seconds |
+./spec/features/upload_file_to_bucket_spec.rb[1:2]                                  | passed | 0.00448 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:1:1]                                   | passed | 0.00143 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:2:1]                                   | passed | 0.00013 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.0001 seconds  |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:5:1:1]                                 | passed | 0.00008 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.00009 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:1:1]                                 | passed | 0.00009 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:7:1:2]                                 | passed | 0.00009 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.0009 seconds  |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:1:1]                                 | passed | 0.00008 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:1:2]                                 | passed | 0.00009 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.00009 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:3:1]                                 | passed | 0.00009 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:3:2]                                 | passed | 0.00008 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:4:1]                                 | passed | 0.00008 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:4:2]                                 | passed | 0.00008 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:5:1]                                 | passed | 0.00009 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:8:5:2]                                 | passed | 0.00008 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:2:1]                                     | passed | 0.00045 seconds |
+./spec/lib/defra_ruby/aws/configuration_spec.rb[1:1:1]                              | passed | 0.00046 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:1:1:1]                                 | passed | 0.00153 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:1:2:1]                                 | passed | 0.00009 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.0001 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.0008 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 |
+./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:1:1]           | passed | 0.00063 seconds |
+./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:2:1]           | passed | 0.00911 seconds |
+./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:1]   | passed | 0.00062 seconds |
+./spec/lib/defra_ruby/aws/services/delete_file_from_bucket_service_spec.rb[1:1:2:1] | passed | 0.00059 seconds |
+./spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb[1:1:1]             | passed | 0.00398 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,16 +65,165 @@ 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
 

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

@@ -5,31 +5,58 @@ 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
+        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(::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)
+            expect(described_class.run(bucket, file)).to be_a(Response)
+          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.3.1
 platform: ruby
 authors:
 - Defra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3