wt_s3_signer 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d14080be11be7b5aeed75a44dba5001d2bcff106c5277ec679666381efe5c5
-  data.tar.gz: dfa138218f64787226846defd64051c76ad65d95b81d420919357a7366cfcda3
+  metadata.gz: 4d9af4f1dd28d4da07932e0515d3afef4283e170ecd04a4346671bc5bed0a3bb
+  data.tar.gz: ee1534d3b34ae69f947ac936298f0b20b22e3ce356a85b8bfd16329d023bae47
 SHA512:
-  metadata.gz: cea9671eff80aa7ae3919f6e3a684238191329cb694857eb33c1478603078c77f62a8d1c62357f804014f4c69329814fe35a0eca9a84f5101b7e7f99e7ba6ebd
-  data.tar.gz: df2fea55f7c659d08cf8184da7d9b921e34d575e4b0731a6f4a50ac6230c64c7a501123f1711e8a1ba87877da42527aaeb9636a00927265222ccc76dba12b6cc
+  metadata.gz: 2b8b4b29b4943746bbddb007d81a6b398d8bbe60b58ea0751cb21c3e264cca66393d5d2baf94c55230795f75f85bc56fd65eb5b946082830f1ea2fde459d6d8e
+  data.tar.gz: 259d5038c1becca0b990c99f236f1bc9e76fc179401f06e366f5482481a8bd3b442e3cfc6e25d3636e725019b8c4ae0a329dc5a298253ddb28c8846a6decd21e

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# YARD output
+doc/
+.yardoc/

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  wetransfer_style: ruby/default.yml

data/.travis.yml

@@ -0,0 +1,16 @@
+rvm:
+- 2.2.10
+- 2.6.5
+sudo: false
+cache: bundler
+script:
+  - sudo apt update
+  - sudo apt install -y awscli jq
+  - assume_role=$(aws sts assume-role --role-arn "$ASSUME_ROLE_ARN" --role-session-name "wt_s3_signer")
+  - export AWS_ACCESS_KEY_ID=$(echo "$assume_role" | jq -r .Credentials.AccessKeyId)
+  - export AWS_SECRET_ACCESS_KEY=$(echo "$assume_role" | jq -r .Credentials.SecretAccessKey)
+  - export AWS_SESSION_TOKEN=$(echo "$assume_role" | jq -r .Credentials.SessionToken)
+  - bundle exec rake
+env:
+  global:
+    - AWS_REGION=eu-west-1

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.3.0
+* Add option `client:` to `WT::S3Signer.for_s3_bucket`, so it's possible to inject a cached `Aws::S3::Client` instance and prevent too many requests to the AWS metadata endpoint

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [julik@wetransfer.com](mailto:julik@wetransfer.com) and [luca-suriano@wetransfer.com](mailto:luca-suriano@wetransfer.com). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,162 @@
+# Contributing to wt_s3_signer
+
+As the creators, and maintainers of this project, we're glad to share our projects and invite contributors to help us stay up to date. Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
+
+In general, we expect you to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Using the issue tracker for bug reports, feature requests and discussions
+
+### First time contributors
+We should encourage first time contributors. A good inspiration on this can be found [here](http://www.firsttimersonly.com/). As pointed out:
+
+> If you are an OSS project owner, then consider marking a few open issues with the label first-timers-only. The first-timers-only label explicitly announces:
+
+> "I'm willing to hold your hand so you can make your first PR. This issue is rather a bit easier than normal. And anyone who’s already contributed to open source isn’t allowed to touch this one!"
+
+By labeling issues with this `first-timers-only` label we help first time contributors step up their game and start contributing.
+
+### Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** — check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** — try to reproduce it using the
+   latest `master` or development branch in the repository.
+
+3. **Isolate the problem** — provide clear steps to reproduce.
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the OS environment in which it occurs. If
+> suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+
+### Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the project's developers of the merits of this feature. Please
+provide as much detail and context as possible.
+
+Do check if the feature request already exists. If it does, give it a thumbs-up emoji
+or even comment. We'd like to avoid duplicate requests.
+
+### Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic
+help. They should remain focused in scope and avoid containing unrelated
+commits.
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code, porting to a different language),
+otherwise you risk spending a lot of time working on something that the
+project's developers might not want to merge into the project. As far as _where_ to ask,
+the feature request or bug report is the best place to go.
+
+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+
+Follow this process if you'd like your work considered for inclusion in the
+project:
+
+1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone git@github.com:WeTransfer/wt_s3_signer.git
+   # Navigate to the newly cloned directory
+   cd wt_s3_signer
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream git@github.com:WeTransfer/wt_s3_signer.git
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout <dev-branch>
+   git pull upstream <dev-branch>
+   ```
+
+3. Create a new topic branch (off the main project development branch) to
+   contain your feature, change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks.
+
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream <dev-branch>
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.
+
+### Conventions of commit messages
+
+Adding features on repo
+
+```bash
+git commit -m "feat: message about this feature"
+```
+
+Fixing features on repo
+
+```bash
+git commit -m "fix: message about this update"
+```
+
+Removing features on repo
+
+```bash
+git commit -m "refactor: message about this" -m "BREAKING CHANGE: message about the breaking change"
+```
+
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
+license your work under the same license as that used by the project.
+
+### Discussions
+
+We aim to keep all project discussion inside GitHub issues. This is to make sure valuable discussion is accessible via search. If you have questions about how to use the library, or how the project is running - GitHub issues are the goto tool for this project.
+
+#### Our expectations on you as a contributor
+
+We want contributors to provide ideas, keep the ship shipping and to take some of the load from others. It is non-obligatory; we’re here to get things done in an enjoyable way. 🎉
+
+The fact that you'll have push access will allow you to:
+
+- Avoid having to fork the project if you want to submit other pull requests as you'll be able to create branches directly on the project.
+- Help triage issues, merge pull requests.
+- Pick up the project if other maintainers move their focus elsewhere.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wt_s3_signer.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,15 @@
+Copyright 2020 WeTransfer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+* No Harm: The software may not be used by anyone for systems or activities that actively and knowingly endanger, harm, or otherwise threaten the physical, mental, economic, or general well-being of other individuals or groups, in violation of the United Nations Universal Declaration of Human Rights (https://www.un.org/en/universal-declaration-human-rights/).
+
+* Services: If the Software is used to provide a service to others, the licensee shall, as a condition of use, require those others not to use the service in any way that violates the No Harm clause above.
+
+* Enforceability: If any portion or provision of this License shall to any extent be declared illegal or unenforceable by a court of competent jurisdiction, then the remainder of this License, or the application of such portion or provision in circumstances other than those as to which it is so declared illegal or unenforceable, shall not be affected thereby, and each portion and provision of this Agreement shall be valid and enforceable to the fullest extent permitted by law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This Hippocratic License is an Ethical Source license (https://ethicalsource.dev) derived from the MIT License, amended to limit the impact of the unethical use of open source software.

data/README.md

@@ -0,0 +1,67 @@
+# wt_s3_signer [![Build Status](https://travis-ci.org/WeTransfer/wt_s3_signer.svg?branch=master)](https://travis-ci.org/WeTransfer/wt_s3_signer)
+
+An optimized AWS S3 URL signer.
+
+## Basic usage
+
+```ruby
+s3_bucket = Aws::S3::Bucket.new('shiny-bucket-name')
+ttl_seconds = 7 * 24 * 60 * 60
+
+# we suggest caching the S3 client in the application to reuse the cached credentials
+s3_client = Aws::S3::Client.new
+signer = WT::S3Signer.for_s3_bucket(s3_bucket, client: s3_client, expires_in: ttl_seconds)
+url_str = signer.presigned_get_url(object_key: full_s3_key)
+      #=> https://shiny-bucket-name.s3.eu-west-1.amazonaws.com/dir/testobject?X-Amz-Algorithm...
+```
+
+## Why would you want to use it?
+
+The use case is when you need to rapidly generate *lots* of presigned URLs to the same S3 bucket. When
+doing the signing, the AWS SDK works fine - but the following operations need to be performed:
+
+* Credential refresh
+* Bucket region discovery (in which region does the bucket reside?)
+* Bucket endpoint discovery (which hostname should be used for the request?)
+* Cleanup of the various edge cases (blacklisted signed headers and so on)
+
+The metadata should be retrieved only once if the bucket does not change, but with the standard
+SDK this information might get refreshed often. And there is a substantial amount of generic
+code that gets called throughout the SDK call even though it is not strictly necessary.
+
+Our signer bypasses these operations and it performs the credential discovery, as well as bucket
+metadata discovery, but *only once* - when you instantiate it. The primary usage pattern is as follows:
+
+```ruby
+signer = WT::S3Signer.for_bucket(my_bucket_resource)
+signed_urls = all_object_keys.map do |obj_key|
+  signer.presigned_get_url(object_key: obj_key)
+end
+```
+
+This will stay performant even if `signed_urls` contains tens of thousands of entries.
+
+Additionally, we cache all the produced strings very aggressively if they do not change between
+calls to the signing method. We also derive the signing key only once. This optimizes the signing even more.
+
+Here are some benchmarks we have made for comparison. The `S3Signer_SDK` class executed the same
+flow, but it reused the [Aws::S3::Presigner](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Presigner.html)
+object that it would instantiate only once, and then call repeatedly.
+
+```
+Warming up --------------------------------------
+WT::S3::Signer#presigned_get_url
+                         9.325k i/100ms
+S3Signer_SDK#presigned_get_url
+                       154.000  i/100ms
+Calculating -------------------------------------
+WT::S3::Signer#presigned_get_url
+                         81.422k (±18.9%) i/s -    391.650k in   5.042435s
+S3Signer_SDK#presigned_get_url
+                          1.865k (± 9.3%) i/s -      9.240k in   5.009593s
+
+Comparison:
+WT::S3::Signer#presigned_get_url:  81421.7 i/s
+S3Signer_SDK#presigned_get_url:     1864.9 i/s - 43.66x  slower
+```
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'yard'
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  # The dash has to be between the two to "divide" the source files and
+  # miscellaneous documentation files that contain no code
+  t.files = ['lib/**/*.rb', '-', 'LICENSE.md']
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/wt_s3_signer.rb

@@ -26,16 +26,18 @@ module WT
     # region and so forth.
     #
     # @param bucket[Aws::S3::Bucket] the AWS bucket resource object
+    # @param client[Aws::S3::Client] an instance AWS S3 Client. It's recommended
+    # to cache it in the application to avoid having too many HTTP requests to
+    # the AWS instance metadata endpoint
     # @param extra_attributes[Hash] any extra keyword arguments to pass to `S3Signer.new`
     # @return [WT::S3Signer]
-    def self.for_s3_bucket(bucket, **extra_attributes)
+    def self.for_s3_bucket(bucket, client: Aws::S3::Client.new, **extra_attributes)
       kwargs = {}
 
       kwargs[:bucket_endpoint_url] = bucket.url
       kwargs[:bucket_host] = URI.parse(bucket.url).host
       kwargs[:bucket_name] = bucket.name
 
-      client = Aws::S3::Client.new
       resp = client.get_bucket_location(bucket: bucket.name)
       aws_region = resp.data.location_constraint
 

data/lib/wt_s3_signer/version.rb

@@ -0,0 +1,5 @@
+module WT
+  class S3Signer
+    VERSION = '0.3.0'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'wt_s3_signer'
+require 'aws-sdk-s3'
+require 'rspec-benchmark'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require_relative 'support/resource_allocator'
+
+AWS_ALLOCATOR = ResourceAllocator.new
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.include RSpec::Benchmark::Matchers
+  AWS_ALLOCATOR.install_rspec_hooks!(config)
+end

data/spec/support/resource_allocator.rb

@@ -0,0 +1,130 @@
+require 'set'
+
+# The resource allocator manages mutable resources that we create during test runs,
+# such as AWS buckets. It is kind of a tiny implementation of Go's `defer`, and ot
+# creates an allocation group for each level of RSpec's expectation pre/post actions.
+# Specifically
+#
+#  resources on :suite level
+#    resources on :all level
+#     resources on :all level for a context
+#       resources on :each level for a specific example
+#       resources allocated during test
+#
+# When a scope is finished in RSpec, the allocation group will be "popped" from the stack
+# and all resources for which cleanup has been defined during allocation will be deleted
+# and cleaned up. This can be used for all sorts of test resources, but mostly for S3 buckets
+# and SQS queues and the like. The allocator will ensure that the cleanup blocks are
+# all called in the reverse order they were called for the case there are resource
+# dependencies
+#
+# * each allocated resource is named in a unique and non ambiguous way
+# * that each process uses it's own numbering sequence for allocated resource names
+# * that resources are named with date and time in the name so if they are leaked you can see when they got created
+class ResourceAllocator
+  def initialize(common_prefix: "wt-s3-signer-test")
+    @ctr = 0
+    @common_prefix = common_prefix
+    @allocation_groups = [[]]
+    @names = Set.new
+    @test_time_str = Time.now.utc.strftime("%Y%m%d%H%M")
+    @common = alphanumeric_seed(4)
+  end
+
+  def computed_prefix
+    "#{@common_prefix}-#{@test_time_str}-#{@common}-...-..."
+  end
+
+  def resource_count
+    @allocation_groups.map(&:length).inject(&:+).to_i
+  end
+
+  def push_alloc_group
+    @allocation_groups << []
+  end
+
+  def alphanumeric_seed(n_chars)
+    alphabet = ('a'..'z').to_a + ('0'..'9').to_a
+    n_chars.times.map { alphabet[SecureRandom.random_number(alphabet.length)] }.join
+  end
+
+  def alloc_resource_name
+    loop do
+      @ctr += 1
+      salt = alphanumeric_seed(5) # even more collision prevention
+      generated_name = "#{@common_prefix}-#{@test_time_str}-#{@common}-#{@ctr}-#{salt}"
+      unless @names.include?(generated_name)
+        @names << generated_name
+        return generated_name
+      end
+    end
+  end
+
+  def create_sqs_queue_name_and_url
+    name = alloc_resource_name
+
+    client = Aws::SQS::Client.new
+    resp = client.create_queue(queue_name: name)
+    url = resp.queue_url
+
+    cleanup_later(name: name, resource_type: :s3_bucket) do
+      client = Aws::SQS::Client.new
+      client.delete_queue(queue_url: url) rescue nil
+    end
+
+    [name, url]
+  end
+
+  def create_s3_bucket_and_name
+    name = alloc_resource_name
+    bucket_resource = Aws::S3::Bucket.new(name)
+    bucket_resource.create
+    cleanup_later(name: name, resource_type: :s3_bucket) do
+      bucket_resource.delete!
+    end
+    [bucket_resource, name]
+  end
+
+  def cleanup_later(resource_type: :unknown, name: alloc_resource_name, &resource_cleanup)
+    # Store the block for later, and return the name immediately
+    @allocation_groups << [] unless @allocation_groups.any?
+    @allocation_groups.last << [name, resource_type, resource_cleanup]
+    name
+  end
+
+  def pop_alloc_group
+    resources_to_remove = @allocation_groups.pop || []
+    resources_to_remove.reverse_each do |name, resource_type, cleanup_proc|
+      cleanup_proc.call(name, resource_type)
+    end
+  end
+
+  def cleanup_all
+    pop_alloc_group while @allocation_groups.any?
+  end
+
+  def install_rspec_hooks!(config)
+    this_allocator = self
+    config.before :suite do
+      this_allocator.push_alloc_group
+    end
+
+    config.before :all do
+      this_allocator.push_alloc_group
+    end
+
+    config.after :all do
+      this_allocator.pop_alloc_group
+    end
+
+    config.around :each do |example|
+      this_allocator.push_alloc_group
+      example.run
+      this_allocator.pop_alloc_group
+    end
+
+    config.after :suite do
+      this_allocator.cleanup_all
+    end
+  end
+end

data/spec/url_signing_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require 'net/http'
+
+shared_context 'signer_bucket' do
+  let(:bucket) { AWS_ALLOCATOR.create_s3_bucket_and_name.first }
+  let(:signer) { described_class.for_s3_bucket(bucket, expires_in: 173) }
+end
+
+describe WT::S3Signer do
+  include_context 'signer_bucket'
+
+  it 'WT::Signer is faster than Aws::S3::Presigner' do
+    allow(WT::S3Signer).to receive(:create_bucket).and_return(bucket)
+
+    bucket.object('dir/testobject').put(body: 'is here')
+
+    # These values come from previous performance measurements ran on nu_backend
+    expect { bucket.object('dir/testobject').presigned_url(:get, expires_in: 173) }.to perform_at_least(1000).ips
+    expect { signer.presigned_get_url(object_key: 'dir/testobject') }.to perform_at_least(40_000).ips
+  end
+
+  it 'signs an s3 key' do
+    allow(WT::S3Signer).to receive(:create_bucket).and_return(bucket)
+
+    bucket.object('dir/testobject').put(body: 'is here')
+    presigned_url = signer.presigned_get_url(object_key: 'dir/testobject')
+
+    expect(presigned_url).to include("X-Amz-Expires=173")
+  end
+
+  it 'signs a valid s3 key' do
+    allow(WT::S3Signer).to receive(:create_bucket).and_return(bucket)
+
+    bucket.object('dir/testobject').put(body: 'is here')
+    presigned_url = signer.presigned_get_url(object_key: 'dir/testobject')
+
+    uri = URI(presigned_url)
+    res = Net::HTTP.get_response(uri)
+
+    expect(res.code).to eq("200")
+  end
+
+  it 'throws an exception if no key is used for signing' do
+    expect{signer.presigned_get_url(object_key: '')}.to raise_error(ArgumentError)
+  end
+
+  describe '.for_s3_bucket' do
+    it 'accepts an s3_client instance via dependency injection' do
+      allow(WT::S3Signer).to receive(:create_bucket).and_return(bucket)
+      bucket.object('dir/testobject').put(body: 'is here')
+
+      s3_client = Aws::S3::Client.new
+
+      expect(Aws::S3::Client).not_to receive(:new)
+
+      signer = described_class.for_s3_bucket(
+        bucket, client: s3_client, expires_in: 174
+      )
+
+      presigned_url = signer.presigned_get_url(object_key: 'dir/testobject')
+
+      expect(presigned_url).to include("X-Amz-Expires=174")
+    end
+  end
+end

data/wt_s3_signer.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wt_s3_signer/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = "wt_s3_signer"
+  spec.version     = WT::S3Signer::VERSION
+  spec.date        = "2019-12-16"
+  spec.summary     = "A library for signing S3 key faster"
+  spec.description = "A Ruby Gem that optimize the signing of S3 keys. The gem is especially useful when dealing with a large amount of S3 object keys"
+  spec.authors     = ["Luca Suriano", "Julik Tarkhanov"]
+  spec.email       = ["luca.suriano@wetransfer.com", "me@julik.nl"]
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.homepage    = "https://github.com/WeTransfer/wt_s3_signer"
+  spec.license     = "MIT (Hippocratic)"
+
+  spec.add_runtime_dependency "aws-sdk-s3", "~> 1"
+
+  spec.add_development_dependency "yard", "~> 0.9.24"
+  spec.add_development_dependency "rake", "~> 13.0.1"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rspec-benchmark", "~> 0.6"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wt_s3_signer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Luca Suriano
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -104,7 +104,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
 - lib/wt_s3_signer.rb
+- lib/wt_s3_signer/version.rb
+- spec/spec_helper.rb
+- spec/support/resource_allocator.rb
+- spec/url_signing_spec.rb
+- wt_s3_signer.gemspec
 homepage: https://github.com/WeTransfer/wt_s3_signer
 licenses:
 - MIT (Hippocratic)
@@ -124,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A library for signing S3 key faster