wt_s3_signer 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d9af4f1dd28d4da07932e0515d3afef4283e170ecd04a4346671bc5bed0a3bb
-  data.tar.gz: ee1534d3b34ae69f947ac936298f0b20b22e3ce356a85b8bfd16329d023bae47
+  metadata.gz: f0f72f6633de6786061caf9225caea94b6d5eeb40083895962c10ac06d711730
+  data.tar.gz: 87d6086cc05d0372442bf3ca05623fa47865a45acd758e4a0450e5329cc4aa76
 SHA512:
-  metadata.gz: 2b8b4b29b4943746bbddb007d81a6b398d8bbe60b58ea0751cb21c3e264cca66393d5d2baf94c55230795f75f85bc56fd65eb5b946082830f1ea2fde459d6d8e
-  data.tar.gz: 259d5038c1becca0b990c99f236f1bc9e76fc179401f06e366f5482481a8bd3b442e3cfc6e25d3636e725019b8c4ae0a329dc5a298253ddb28c8846a6decd21e
+  metadata.gz: 876a30ce3e8074072fb2380a3083ead9980948774cc41d0c28ac7ce8815b09271b5b764bb1e897eeba6de5b762b81206c50e28b69bb9df7df7df611329819416
+  data.tar.gz: aae3c570d6db90e7274c47bdd99b9d1bd5c53ca2a2715d137577dda6c6120c5a3db9eb858acebc8259efb8308143d4b9a8a4d8da6830a98999c5bc2913a8b01a

data/CHANGELOG.md

@@ -1,2 +1,6 @@
+## 1.0.0
+* Remove option `client:` `from WT::S3Signer.for_s3_bucket`
+* Uses a singleton s3_client by default to take advantage of AWS credentials cache
+
 ## 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/lib/wt_s3_signer.rb

@@ -31,7 +31,7 @@ module WT
     # 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, client: Aws::S3::Client.new, **extra_attributes)
+    def self.for_s3_bucket(bucket, **extra_attributes)
       kwargs = {}
 
       kwargs[:bucket_endpoint_url] = bucket.url
@@ -170,6 +170,13 @@ module WT
       Aws::S3::Bucket.new(bucket_name)
     end
 
+    # AWS gems have a mechanism to cache credentials internally. So take
+    # advantage of this, it's necessary to use the same client instance.
+    def self.client
+      @client ||= Aws::S3::Client.new
+    end
+    private_class_method :client
+
     def derive_signing_key(key, datestamp, region, service)
       prefixed_key = "AWS4" + key
       k_date = hmac_bytes(prefixed_key, datestamp)

data/lib/wt_s3_signer/version.rb

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

data/spec/url_signing_spec.rb

@@ -45,21 +45,22 @@ describe WT::S3Signer do
   end
 
   describe '.for_s3_bucket' do
-    it 'accepts an s3_client instance via dependency injection' do
+    it 'uses a singleton instance of s3 client' 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
+      # If other tests run before, they might instantiate the singleton client,
+      # so it's acceptable for Aws::S3::Client to not receive :new
+      expect(Aws::S3::Client).to receive(:new).at_most(:once).and_call_original
 
-      expect(Aws::S3::Client).not_to receive(:new)
+      signer1 = described_class.for_s3_bucket(bucket, expires_in: 174)
+      signer2 = described_class.for_s3_bucket(bucket, expires_in: 175)
 
-      signer = described_class.for_s3_bucket(
-        bucket, client: s3_client, expires_in: 174
-      )
+      presigned_url1 = signer1.presigned_get_url(object_key: 'dir/testobject')
+      presigned_url2 = signer2.presigned_get_url(object_key: 'dir/testobject')
 
-      presigned_url = signer.presigned_get_url(object_key: 'dir/testobject')
-
-      expect(presigned_url).to include("X-Amz-Expires=174")
+      expect(presigned_url1).to include("X-Amz-Expires=174")
+      expect(presigned_url2).to include("X-Amz-Expires=175")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wt_s3_signer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Luca Suriano
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A library for signing S3 key faster