defra_ruby_aws 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f98773dfc3468b835ccb7120609f527544bb794
+  data.tar.gz: 450ba740fa675f36bcd7b1c072524e06306e0f0f
+SHA512:
+  metadata.gz: bce99a5fbe92846cdf796771c153b3a90d2fef9459458f87f89e6626b24011c3bff84f5a42ba8ef4e457fa9bc297e4c59e8774fffdb958d0573fc6a46f524fd3
+  data.tar.gz: 27d93f4cc90f7d8eb5445017a990215afec9e345d9121dd04243fd734854cfd8362c7c1403b7c8891199b26a236b0871c526b345075cd12c730957b28eba9f86

data/README.md

@@ -0,0 +1,93 @@
+# DefraRuby::Aws
+
+[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-aws.svg?branch=master)](https://travis-ci.com/DEFRA/defra-ruby-aws)
+[![Maintainability](https://api.codeclimate.com/v1/badges/4541a29b2c675b03a5ed/maintainability)](https://codeclimate.com/github/DEFRA/defra-ruby-aws/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/4541a29b2c675b03a5ed/test_coverage)](https://codeclimate.com/github/DEFRA/defra-ruby-aws/test_coverage)
+[![security](https://hakiri.io/github/DEFRA/defra-ruby-aws/master.svg)](https://hakiri.io/github/DEFRA/defra-ruby-aws/master)
+[![Gem Version](https://badge.fury.io/rb/defra_ruby_aws.svg)](https://badge.fury.io/rb/defra_ruby_aws)
+[![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
+
+Package of Ruby helpers for connecting Rails applications to AWS S3.
+
+## Installation
+
+Add this line to your application's Gemfile
+
+```ruby
+gem 'defra_ruby_aws'
+```
+
+And then update your dependencies by calling
+
+```bash
+bundle install
+```
+
+## Configuration
+
+Add a new bucket with:
+
+```ruby
+# config/initializers/defra_ruby_aws.rb
+require "defra_ruby/aws"
+
+DefraRuby::Aws.configure do |config|
+  config.buckets = [{
+    # bucket's name, required
+    name: "defra-ruby-aws",
+    # AWS bucket access credentials, required
+    credentials: {
+      access_key_id: "ACCESS_KEY_ID",
+      secret_access_key: "SECRET_ACCESS_KEY"
+    },
+    # optional - Default to "eu-west-1"
+    region: "eu-west-1"
+  }]
+end
+```
+
+## Usage
+
+### Upload a file
+
+```ruby
+file_to_upload = Tempfile.new("test-upload-file.csv")
+bucket = DefraRuby::Aws.get_bucket("defra-ruby-aws")
+response = bucket.load(file_to_upload)
+
+if response.successful?
+  # Do something
+else
+  response.error # return the failure error
+  # Do something else
+end
+```
+
+### Generate a presigned URL for download
+
+```ruby
+bucket = DefraRuby::Aws.get_bucket("defra-ruby-aws")
+presigned_url = bucket.presigned_url("test-upload-file.csv")
+```
+
+## Contributing to this project
+
+If you have an idea you'd like to contribute please log an issue.
+
+All contributions should be submitted via a pull request.
+
+## License
+
+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
+
+The following attribution statement MUST be cited in your products and applications when using this information.
+
+> Contains public sector information licensed under the Open Government license v3
+
+### About the license
+
+The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
+
+It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+Bundler::GemHelper.install_tasks
+
+# This is wrapped to prevent an error when rake is called in environments where
+# rspec may not be available, e.g. production. As such we don't need to handle
+# the error.
+# rubocop:disable Lint/HandleExceptions
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end
+
+begin
+  require "github_changelog_generator/task"
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  end
+rescue LoadError
+  # no changelog available
+end
+# rubocop:enable Lint/HandleExceptions

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "defra_ruby/aws"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/defra_ruby.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "defra_ruby/aws"
+
+module DefraRuby
+  # The Defra Ruby packages namespace.
+end

data/lib/defra_ruby/aws.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "aws/bucket"
+require_relative "aws/response"
+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"
+
+module DefraRuby
+  module Aws
+    class << self
+      attr_accessor :configuration
+
+      def configure
+        require "aws-sdk-s3"
+
+        self.configuration ||= Configuration.new
+        yield(configuration)
+      end
+
+      def get_bucket(bucket_name)
+        configuration.buckets.select do |bucket|
+          bucket.bucket_name == bucket_name
+        end.first
+      end
+    end
+  end
+end

data/lib/defra_ruby/aws/bucket.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Aws
+    class Bucket
+      attr_reader :bucket_name, :credentials, :region
+
+      def initialize(configs)
+        @credentials = configs[:credentials]
+        @bucket_name = configs[:name]
+        @region = setup_region(configs[:region])
+
+        validate!
+      end
+
+      def access_key_id
+        credentials[:access_key_id]
+      end
+
+      def secret_access_key
+        credentials[:secret_access_key]
+      end
+
+      def load(file)
+        BucketLoaderService.run(self, file)
+      end
+
+      def presigned_url(file_name)
+        PresignedUrlService.run(self, file_name)
+      end
+
+      private
+
+      attr_writer :region
+
+      def setup_region(region)
+        return default_region if region.nil? || region.empty?
+
+        region
+      end
+
+      def default_region
+        "eu-west-1"
+      end
+
+      def validate!
+        validate_presence_of_name!
+        validate_presence_of_credentials!
+      end
+
+      def validate_presence_of_name!
+        raise_not_valid_name if bucket_name.nil? || bucket_name.empty?
+      end
+
+      def validate_presence_of_credentials!
+        raise_missing_credentials if empty?(credentials)
+        raise_missing_access_key if empty?(access_key_id)
+        raise_missing_secret_access_key if empty?(secret_access_key)
+      end
+
+      def raise_not_valid_name
+        raise("DefraRuby::Aws buckets configurations: missing bucket name")
+      end
+
+      def raise_missing_credentials
+        raise("DefraRuby::Aws buckets configurations: missing credentials for bucket #{bucket_name}")
+      end
+
+      def raise_missing_access_key
+        raise("DefraRuby::Aws buckets configurations: missing access key id for bucket #{bucket_name}")
+      end
+
+      def raise_missing_secret_access_key
+        raise("DefraRuby::Aws buckets configurations: missing secret access key for bucket #{bucket_name}")
+      end
+
+      def empty?(object)
+        object.nil? || object.empty?
+      end
+    end
+  end
+end

data/lib/defra_ruby/aws/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Aws
+    class Configuration
+      attr_reader :buckets
+
+      def initialize
+        @buckets = {}
+      end
+
+      def buckets=(buckets_configurations)
+        @buckets = buckets_configurations.map do |configs|
+          Bucket.new(configs)
+        end
+      end
+    end
+  end
+end

data/lib/defra_ruby/aws/response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Aws
+    class Response
+      attr_reader :error
+
+      def initialize(response_exe)
+        @success = true
+        @error = nil
+
+        capture_response(response_exe)
+      end
+
+      def successful?
+        success
+      end
+
+      private
+
+      attr_reader :success
+
+      def capture_response(response_exe)
+        response_exe.call
+      rescue StandardError => e
+        @error = e
+        @success = false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Aws
+    class BucketLoaderService
+      include HasAwsBucketConfiguration
+
+      def self.run(bucket, file)
+        new(bucket, file).run
+      end
+
+      def initialize(bucket, file)
+        @bucket = bucket
+        @file = file
+      end
+
+      def run
+        Response.new(response_exe)
+      end
+
+      private
+
+      attr_reader :bucket, :file
+
+      def response_exe
+        lambda do
+          s3_bucket.object(File.basename(file.path)).upload_file(file.path, server_side_encryption: :AES256)
+        end
+      end
+    end
+  end
+end

data/lib/defra_ruby/aws/services/concerns/has_aws_bucket_configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Aws
+    module HasAwsBucketConfiguration
+      def s3_bucket
+        s3.bucket(bucket.bucket_name)
+      end
+
+      def s3
+        ::Aws::S3::Resource.new(
+          region: bucket.region,
+          credentials: aws_credentials
+        )
+      end
+
+      def aws_credentials
+        ::Aws::Credentials.new(bucket.access_key_id, bucket.secret_access_key)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Aws
+    class PresignedUrlService
+      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
+        s3_bucket.object(file_name).presigned_url(
+          :get,
+          expires_in: 20 * 60, # 20 minutes in seconds
+          secure: true,
+          response_content_type: "text/csv",
+          response_content_disposition: "attachment; filename=#{file_name}"
+        )
+      end
+
+      private
+
+      attr_reader :bucket, :file_name
+    end
+  end
+end

data/lib/defra_ruby/aws/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Aws
+    VERSION = "0.1.0"
+  end
+end

data/spec/defra_ruby_aws_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe DefraRuby::Aws do
+  it "has a version number" do
+    expect(DefraRuby::Aws::VERSION).not_to be nil
+  end
+end

data/spec/examples.txt

@@ -0,0 +1,17 @@
+example_id                                                              | status | run_time        |
+----------------------------------------------------------------------- | ------ | --------------- |
+./spec/defra_ruby_aws_spec.rb[1:1]                                      | passed | 0.00122 seconds |
+./spec/features/upload_file_to_bucket_spec.rb[1:1]                      | passed | 0.0124 seconds  |
+./spec/features/upload_file_to_bucket_spec.rb[1:2]                      | passed | 0.00574 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:1:1]                       | passed | 0.00174 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.00017 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:1:4:1]                       | passed | 0.00014 seconds |
+./spec/lib/defra_ruby/aws/bucket_spec.rb[1:2:1]                         | passed | 0.00213 seconds |
+./spec/lib/defra_ruby/aws/configuration_spec.rb[1:1:1]                  | passed | 0.00061 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:1:1:1]                     | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:1:2:1]                     | passed | 0.00014 seconds |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:2:1:1]                     | passed | 0.0001 seconds  |
+./spec/lib/defra_ruby/aws/response_spec.rb[1:2:2:1]                     | passed | 0.00011 seconds |
+./spec/lib/defra_ruby/aws/services/bucket_loader_service_spec.rb[1:1:1] | passed | 0.01269 seconds |
+./spec/lib/defra_ruby/aws/services/presigned_url_service_spec.rb[1:1:1] | passed | 0.00368 seconds |

data/spec/features/upload_file_to_bucket_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Defra Ruby AWS" do
+  it "Upload a file to an AWS bucket" do
+    configure_gem
+    stub_successful_request
+
+    bucket = DefraRuby::Aws.get_bucket("bulk-test")
+    response = bucket.load(Tempfile.new("test-bucket-load.test"))
+
+    expect(response).to be_successful
+  end
+
+  it "fails gracefully" do
+    configure_gem
+    stub_failing_request
+
+    bucket = DefraRuby::Aws.get_bucket("bulk-test")
+    response = bucket.load(Tempfile.new("test-bucket-load.test"))
+
+    expect(response).to_not be_successful
+    expect(response.error).to be_a(Aws::S3::Errors::Forbidden)
+  end
+
+  def configure_gem
+    DefraRuby::Aws.configure do |config|
+      config.buckets = [{
+        name: "bulk-test",
+        credentials: {
+          access_key_id: "ACCESS_KEY_ID",
+          secret_access_key: "SECRET_ACCESS_KEY"
+        }
+      }]
+    end
+  end
+
+  def stub_successful_request
+    stub_request(:put, %r{https:\/\/bulk-test\.s3\.eu-west-1\.amazonaws\.com\/test-bucket-load\..+})
+  end
+
+  def stub_failing_request
+    stub_request(
+      :put,
+      %r{https:\/\/bulk-test\.s3\.eu-west-1\.amazonaws\.com\/test-bucket-load\..+}
+    ).to_return(
+      status: 403
+    )
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module DefraRuby
+  module Aws
+    RSpec.describe Bucket do
+      subject(:bucket) { described_class.new(configs) }
+
+      describe "#initialize" do
+        context "when a name configuration is missing" do
+          let(:configs) do
+            {
+              name: nil,
+              credentials: {}
+            }
+          end
+
+          it "raises an error" do
+            expect { bucket }.to raise_error("DefraRuby::Aws buckets configurations: missing bucket name")
+          end
+        end
+
+        context "when credentials configuration is missing" do
+          let(:configs) do
+            {
+              name: "foo",
+              credentials: {}
+            }
+          end
+
+          it "raises an error" do
+            expect { bucket }.to raise_error("DefraRuby::Aws buckets configurations: missing credentials for bucket foo")
+          end
+        end
+
+        context "when credentials access key id is missing" do
+          let(:configs) do
+            {
+              name: "foo",
+              credentials: {
+                secret_access_key: "secret"
+              }
+            }
+          end
+
+          it "raises an error" do
+            expect { bucket }.to raise_error("DefraRuby::Aws buckets configurations: missing access key id for bucket foo")
+          end
+        end
+
+        context "when credentials secret access key is missing" do
+          let(:configs) do
+            {
+              name: "foo",
+              credentials: {
+                access_key_id: "access_key"
+              }
+            }
+          end
+
+          it "raises an error" do
+            expect { bucket }.to raise_error("DefraRuby::Aws buckets configurations: missing secret access key for bucket foo")
+          end
+        end
+      end
+
+      describe "#load" do
+        let(:configs) do
+          {
+            name: "foo",
+            credentials: {
+              secret_access_key: "secret",
+              access_key_id: "access_key"
+            }
+          }
+        end
+
+        it "loads the given file to the s3 bucket" do
+          result = double(:result)
+          file = double(:file)
+
+          expect(BucketLoaderService).to receive(:run).with(bucket, file).and_return(result)
+          expect(bucket.load(file)).to eq(result)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module DefraRuby
+  module Aws
+    RSpec.describe Configuration do
+      subject(:configuration) { described_class.new }
+
+      describe "#buckets=" do
+        let(:buckets) { %i[foo bar baz] }
+
+        it "creates a list of buckets" do
+          expect(Bucket).to receive(:new).with(:foo)
+          expect(Bucket).to receive(:new).with(:bar)
+          expect(Bucket).to receive(:new).with(:baz)
+
+          configuration.buckets = buckets
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module DefraRuby
+  module Aws
+    RSpec.describe Response do
+      subject(:response) { described_class.new(response_exe) }
+
+      describe "#successful?" do
+        context "when the response throws an error" do
+          let(:response_exe) { -> { raise "Boom!" } }
+
+          it "returns false" do
+            expect(response).to_not be_successful
+          end
+        end
+
+        context "when the response don't throw an error" do
+          let(:response_exe) { -> {} }
+
+          it "returns true" do
+            expect(response).to be_successful
+          end
+        end
+      end
+
+      describe "#error" do
+        context "when the response throws an error" do
+          let(:response_exe) { -> { raise StandardError, "Boom!" } }
+
+          it "returns the error" do
+            expect(response.error).to be_a(StandardError)
+          end
+        end
+
+        context "when the response don't throw an error" do
+          let(:response_exe) { -> {} }
+
+          it "returns a nil object" do
+            expect(response.error).to be_nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+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(: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)
+
+          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
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module DefraRuby
+  module Aws
+    RSpec.describe PresignedUrlService do
+      describe ".run" do
+        let(:configs) do
+          {
+            name: "test",
+            credentials: {
+              access_key_id: "123",
+              secret_access_key: "Secret"
+            }
+          }
+        end
+        let(:bucket) { Bucket.new(configs) }
+        let(:presigned_url) { described_class.run(bucket, "testfile.csv") }
+
+        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/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

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+# Require and run our simplecov initializer as the very first thing we do.
+# This is as per its docs https://github.com/colszowka/simplecov#getting-started
+require "./spec/support/simplecov"
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# We make an exception for simplecov because that will already have been
+# required and run at the very top of spec_helper.rb
+support_files = Dir["./spec/support/**/*.rb"].reject { |file| file == "./spec/support/simplecov.rb" }
+support_files.each { |f| require f }
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/aws_sdk_s3.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Gem that allows us to integrate with AWS S3 (cloud storage)
+require "aws-sdk-s3"

data/spec/support/dotenv.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Load env vars from a text file
+require "dotenv/load"

data/spec/support/pry.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Support debugging in the tests. Add `binding.pry` wherever you want execution
+# to stop and the debugger to kick in.
+# Details on the debugging commands can be found here
+# https://github.com/deivid-rodriguez/pry-byebug#commands
+require "pry-byebug"

data/spec/support/simplecov.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "simplecov"
+
+# We start it with the rails param to ensure it includes coverage for all code
+# started by the rails app, and not just the files touched by our unit tests.
+# This gives us the most accurate assessment of our unit test coverage
+# https://github.com/colszowka/simplecov#getting-started
+SimpleCov.start do
+  # The version file is simply just that, so we do not feel the need to ensure
+  # we have a test for it
+  add_filter "lib/defra_ruby/aws/version"
+end

data/spec/support/webmock.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Library for stubbing and setting expectations on HTTP requests in Ruby
+require "webmock/rspec"

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: defra_ruby_aws
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Defra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: defra_ruby_style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Package of AWS features commonly used in Defra Rails based digital services
+email:
+- alan.cruikshanks@environment-agency.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/defra_ruby.rb
+- lib/defra_ruby/aws.rb
+- lib/defra_ruby/aws/bucket.rb
+- lib/defra_ruby/aws/configuration.rb
+- 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/presigned_url_service.rb
+- lib/defra_ruby/aws/version.rb
+- spec/defra_ruby_aws_spec.rb
+- spec/examples.txt
+- spec/features/upload_file_to_bucket_spec.rb
+- spec/lib/defra_ruby/aws/bucket_spec.rb
+- 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/presigned_url_service_spec.rb
+- spec/spec_helper.rb
+- spec/support/aws_sdk_s3.rb
+- spec/support/dotenv.rb
+- spec/support/pry.rb
+- spec/support/simplecov.rb
+- spec/support/webmock.rb
+homepage: https://github.com/DEFRA/defra-ruby-aws
+licenses:
+- The Open Government Licence (OGL) Version 3
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Defra ruby on rails AWS helpers
+test_files:
+- spec/defra_ruby_aws_spec.rb
+- spec/spec_helper.rb
+- spec/examples.txt
+- spec/features/upload_file_to_bucket_spec.rb
+- spec/support/aws_sdk_s3.rb
+- spec/support/simplecov.rb
+- spec/support/webmock.rb
+- spec/support/pry.rb
+- spec/support/dotenv.rb
+- spec/lib/defra_ruby/aws/configuration_spec.rb
+- 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/presigned_url_service_spec.rb