defra_ruby_aws 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f98773dfc3468b835ccb7120609f527544bb794
-  data.tar.gz: 450ba740fa675f36bcd7b1c072524e06306e0f0f
+  metadata.gz: f9b354b91b6387612b0f6dee19ea11e78773d929
+  data.tar.gz: ce4724a563a416001758583ecc1fe2693122fd71
 SHA512:
-  metadata.gz: bce99a5fbe92846cdf796771c153b3a90d2fef9459458f87f89e6626b24011c3bff84f5a42ba8ef4e457fa9bc297e4c59e8774fffdb958d0573fc6a46f524fd3
-  data.tar.gz: 27d93f4cc90f7d8eb5445017a990215afec9e345d9121dd04243fd734854cfd8362c7c1403b7c8891199b26a236b0871c526b345075cd12c730957b28eba9f86
+  metadata.gz: a4e9aefa9d7e36826ab34a3e8814f3974444f896a950ca425e22db97461e45e5f1e7ea4f5d4f3d8725fee7d5872acb9938bc3e08efd9adf99359b92ee98628a2
+  data.tar.gz: '099bf6de690ea832484508c3223b83f7a82d7fd1bc2ded66a040481491a09674a0c373b1f18558a48737536fb38a19642577e63fa35b32851d78c5e642658268'

data/README.md

@@ -70,6 +70,19 @@ bucket = DefraRuby::Aws.get_bucket("defra-ruby-aws")
 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")
+
+if response.successful?
+  # Do something
+else
+  response.error # return the failure error
+  # Do something else
+end
+```
+
 ## Contributing to this project
 
 If you have an idea you'd like to contribute please log an issue.

data/lib/defra_ruby/aws.rb

@@ -7,6 +7,7 @@ require_relative "aws/configuration"
 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"
 
 module DefraRuby
   module Aws

data/lib/defra_ruby/aws/bucket.rb

@@ -29,6 +29,10 @@ module DefraRuby
         PresignedUrlService.run(self, file_name)
       end
 
+      def delete(file_name)
+        DeleteFileFromBucketService.run(self, file_name)
+      end
+
       private
 
       attr_writer :region

data/lib/defra_ruby/aws/response.rb

@@ -2,6 +2,8 @@
 
 module DefraRuby
   module Aws
+    class UnsuccessfulOperation < StandardError; end
+
     class Response
       attr_reader :error
 
@@ -21,7 +23,7 @@ module DefraRuby
       attr_reader :success
 
       def capture_response(response_exe)
-        response_exe.call
+        raise UnsuccessfulOperation unless response_exe.call
       rescue StandardError => e
         @error = e
         @success = false

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Aws
+    class DeleteFileFromBucketService
+      include HasAwsBucketConfiguration
+
+      def self.run(bucket, file_name)
+        new(bucket, file_name).run
+      end
+
+      def initialize(bucket, file_name)
+        @bucket = bucket
+        @file_name = file_name
+      end
+
+      def run
+        Response.new(response_exe)
+      end
+
+      private
+
+      attr_reader :bucket, :file_name
+
+      def response_exe
+        lambda do
+          delete_object_output = s3_bucket.object(file_name).delete
+
+          delete_object_output.request_charged.length.positive?
+        end
+      end
+    end
+  end
+end

data/lib/defra_ruby/aws/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Aws
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

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

@@ -17,7 +17,31 @@ module DefraRuby
         end
 
         context "when the response don't throw an error" do
-          let(:response_exe) { -> {} }
+          let(:response_exe) { -> { true } }
+
+          it "returns true" do
+            expect(response).to be_successful
+          end
+        end
+
+        context "when the response returns a nil object" do
+          let(:response_exe) { -> { nil } }
+
+          it "returns false" do
+            expect(response).to_not be_successful
+          end
+        end
+
+        context "when the response returns false" do
+          let(:response_exe) { -> { false } }
+
+          it "returns false" do
+            expect(response).to_not be_successful
+          end
+        end
+
+        context "when the response returns an object" do
+          let(:response_exe) { -> { "I am an object" } }
 
           it "returns true" do
             expect(response).to be_successful
@@ -35,7 +59,7 @@ module DefraRuby
         end
 
         context "when the response don't throw an error" do
-          let(:response_exe) { -> {} }
+          let(:response_exe) { -> { true } }
 
           it "returns a nil object" do
             expect(response.error).to be_nil

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module DefraRuby
+  module Aws
+    RSpec.describe DeleteFileFromBucketService 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) }
+
+        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")
+
+          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(:delete).and_return(result)
+
+          response = described_class.run(bucket, file_name)
+          expect(response).to be_successful
+        end
+
+        context "when the response body returns an empty charged requests" 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: "")
+
+            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(:delete).and_return(result)
+
+            response = described_class.run(bucket, file_name)
+            expect(response).to_not be_successful
+          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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Defra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2019-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -154,6 +154,7 @@ files:
 - lib/defra_ruby/aws/response.rb
 - 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/presigned_url_service.rb
 - lib/defra_ruby/aws/version.rb
 - spec/defra_ruby_aws_spec.rb
@@ -163,6 +164,7 @@ files:
 - spec/lib/defra_ruby/aws/configuration_spec.rb
 - 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/presigned_url_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/aws_sdk_s3.rb
@@ -209,4 +211,5 @@ test_files:
 - spec/lib/defra_ruby/aws/response_spec.rb
 - spec/lib/defra_ruby/aws/bucket_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/presigned_url_service_spec.rb