faster_s3_url 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f3c703ea5ea25203b0d37da4ba0272c9619d7d46bbe0eed9bd7a3fd79768473
-  data.tar.gz: a2060cdee17b8731274a4ea997859df1390cf09f4dae2530d2145e3345ffabaf
+  metadata.gz: 19961406eae206e2857fd3f33d6a9f2d17a2f87974accd449db44f00a5d086fd
+  data.tar.gz: 8e490830bd078b73eddfc00eee1f0cc847432bab536cee1a4e5eb2635666cc4a
 SHA512:
-  metadata.gz: e8867a60091b046eb1956589e14666b10bee32711bbadfed2fcfab9e25dde2459e60baf0d61fa2564e73d838a55803ffef11a5e21452d9352b994d0af9749efe
-  data.tar.gz: bb29010a02d2e89773ecf43a8b1c041f81d855f0bd80cbf3251fa00bd5eeb557b73ae51fb53a12a421296276786beed38246a6920b96639628e3dcb8b433c42c
+  metadata.gz: 40b65520c01ae860dea80dba4a25c7817d9a8978c1cbc7bc538d7b0ed92e5c898597340f0c93141355929af98bb7aa7656c95469c758348744ddd77b6666b9ec
+  data.tar.gz: 12d30342cb72e806e6c11e9c0e27b078cd0e1dfa419303437724d76acb698b30ec1b500bde020dd513802d65097ddc7f2997b9e9cfb59bd669f5e6bb085e9fb9

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: ['**']
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.6
+
+    - name: Bundle install
+      run: bundle install --jobs 4 --retry 3
+
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.1.0
+
+### Fixed
+
+- response-expires header format match recent AWS ruby SDK by using #httpdate https://github.com/jrochkind/faster_s3_url/pull/5
+
+- Only define local Storage#object_key if Shrine isn't already providing https://github.com/jrochkind/faster_s3_url/pull/7
+
+### Changed
+
+- Some decrease in memory allocations made by gem https://github.com/jrochkind/faster_s3_url/pull/6

data/Gemfile

@@ -7,5 +7,6 @@ gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 
 gem 'pry-byebug', "~> 3.9"
-# need straight from github to get latest version without deprecations, eg https://github.com/softdevteam/libkalibera/issues/5
-gem 'kalibera', github: "softdevteam/libkalibera"
+# used by benchmark-ips in our perf/ profiling scripts.
+# https://github.com/evanphx/benchmark-ips#advanced-statistics
+gem 'kalibera'

data/README.md

@@ -2,7 +2,8 @@
 
 Generate public and presigned AWS S3 `GET` URLs faster in ruby
 
-[![Gem Version](https://badge.fury.io/rb/faster_s3_url.svg)](https://badge.fury.io/rb/faster_s3_url) [![Build Status](https://travis-ci.com/jrochkind/faster_s3_url.svg?branch=master)](https://travis-ci.com/jrochkind/faster_s3_url)
+[![Gem Version](https://badge.fury.io/rb/faster_s3_url.svg)](https://badge.fury.io/rb/faster_s3_url) [![CI Status](https://github.com/jrochkind/faster_s3_url/workflows/CI/badge.svg?branch=master)](https://github.com/jrochkind/faster_s3_url/actions?query=workflow%3ACI+branch%3Amaster)
+
 
 The official [ruby AWS SDK](https://github.com/aws/aws-sdk-ruby) is actually quite slow and unoptimized when generating URLs to access S3 objects. If you are only creating a couple S3 URLs at a time this may not matter. But it can matter on the order of even two or three hundred at a time, especially when creating presigned URLs, for which the AWS SDK is especially un-optimized.
 

data/faster_s3_url.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "aws-sdk-s3", "~> 1.81"
+  spec.add_development_dependency "nokogiri" # aws gem now has implicit dependency on an XML processor such as
   spec.add_development_dependency "timecop", "< 2"
   spec.add_development_dependency "benchmark-ips", "~> 2.8"
   #spec.add_development_dependency "kalibera" # for benchmark-ips :bootstrap stats option

data/lib/faster_s3_url/builder.rb

@@ -206,7 +206,6 @@ module FasterS3Url
       end
     end
 
-
     # Becaues CGI.escape in MRI is written in C, this really does seem
     # to be the fastest way to get the semantics we want, starting with
     # CGI.escape and doing extra gsubs. Alternative would be using something
@@ -215,7 +214,12 @@ module FasterS3Url
       if string.nil?
         nil
       else
-        CGI.escape(string.encode('UTF-8')).gsub('+', '%20').gsub('%7E', '~')
+        CGI.escape(string.encode('UTF-8')).tap do |s|
+          # there is a clever way to do this in one gsub, but doesn't necessarily help
+          # memory allocations or performance
+          s.gsub!('+'.freeze, '%20'.freeze)
+          s.gsub!('%7E'.freeze, '~'.freeze)
+        end
       end
     end
 
@@ -228,7 +232,13 @@ module FasterS3Url
       if string.nil?
         nil
       else
-        CGI.escape(string.encode('UTF-8')).gsub('+', '%20').gsub('%7E', '~').gsub("%2F", "/")
+        CGI.escape(string.encode('UTF-8')).tap do |s|
+          # there is a clever way to do this in one gsub, but doesn't necessarily help
+          # memory allocations or performance
+          s.gsub!('+'.freeze, '%20'.freeze)
+          s.gsub!('%7E'.freeze, '~'.freeze)
+          s.gsub!('%2F'.freeze, '/'.freeze)
+        end
       end
     end
 
@@ -256,7 +266,7 @@ module FasterS3Url
 
     def validate_expires_in(expires_in)
       if expires_in > ONE_WEEK
-        raise ArgumentError.new("expires_in value of #{expires_in} exceeds one-week maximum.")
+        raise ArgumentError.new("expires_in value of #{expires_in} exceeds one-week (#{ONE_WEEK}) maximum.")
       elsif expires_in <= 0
         raise ArgumentError.new("expires_in value of #{expires_in} cannot be 0 or less.")
       end
@@ -265,14 +275,13 @@ module FasterS3Url
     # Crazy kind of reverse engineered from aws-sdk-ruby,
     # for compatible handling of Expires header.
     #
-    # This honestly seems to violate the HTTP spec, the result will be that for
-    # an `response-expires` param, subsequent S3 response will include an Expires
-    # header in ISO8601 instead of HTTP-date format.... but for now we'll make
-    # our tests pass by behaving equivalently to aws-sdk-s3 anyway? filed
-    # with aws-sdk-s3: https://github.com/aws/aws-sdk-ruby/issues/2415
+    # Recent versions of ruby AWS SDK use "httpdate" format here, as a result of
+    # an issue we filed: https://github.com/aws/aws-sdk-ruby/issues/2415
+    #
+    # We match what recent AWS SDK does.
     #
-    # Switch last line from `.utc.iso8601` to `.httpdate` if you want to be
-    # more correct than aws-sdk-s3?
+    # Note while the AWS SDK source says "rfc 822", it's ruby #httpdate that matches
+    # rather than ruby #rfc822 (timezone should be `GMT` to match AWS SDK, not `-0000`)
     def convert_for_timestamp_shape(arg)
       return nil if arg.nil?
 
@@ -286,7 +295,7 @@ module FasterS3Url
         else
           Time.parse(arg.to_s)
       end
-      time_value.utc.iso8601
+      time_value.utc.httpdate
     end
   end
 end

data/lib/faster_s3_url/shrine/storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 gem "shrine", "~> 3.0"
 require 'shrine/storage/s3'
 
@@ -59,7 +61,7 @@ module FasterS3Url
       end
 
       # For older shrine versions without it, we need this...
-      unless self.method_defined?(:object_key)
+      unless self.method_defined?(:object_key) || self.private_method_defined?(:object_key)
         def object_key(id)
           [*prefix, id].join("/")
         end

data/lib/faster_s3_url/version.rb

@@ -1,3 +1,3 @@
 module FasterS3Url
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faster_s3_url
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonathan Rochkind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-17 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.81'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -87,9 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -125,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Generate public and presigned AWS S3 GET URLs faster

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.6
-before_install: gem install bundler -v 2.1.4