s3_sign 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 447a0d533f6b48c8ba047c28404ed883505f2433
-  data.tar.gz: 459ba0f3170e825a39555cfb43bac368c329ee44
+  metadata.gz: 96c16aa5ab1087cbc5bc750ddc183f1bda15ba37
+  data.tar.gz: 8fd8b1cf944bab603d44e598fabb6a6511561f90
 SHA512:
-  metadata.gz: c3cc28ad515aa2542735e63e49e5843aa0ca4ccdd7a15374a073c2b0c2cbee06c28293ff62dcbde7f2ba02cc5c24c90f96104b93e088436dacf9f8f39ac569e8
-  data.tar.gz: 7672f0e87dc8023452fc00342ec8a5013599cb7f642f7d954e19fb5032dde26371bd9807e505693857d7f8ec6caeb427afa243224b83c51ba7e8f2f30be2a3e5
+  metadata.gz: a03766738b4e08e50fade4f2b77ae9d7591c259eb04bbcd8df35846dff2a8eb2159a1cd0c5b8e0cd132ac709a783fef30bad9f96e498ffc8b65c250668a95126
+  data.tar.gz: 4bebcb938b7640b0b348c7d22a89c8ed8605b5f25fa381420c6f9c2d9c761166351ba18d59de1ed136124eff769038da84c1519932e42f568adf0ee0baaf26f0

data/README.md

@@ -45,7 +45,7 @@ The `S3Sign` module itself provides `.url`:
 
 ```ruby
 # Pass a full s3 url and 1 hour expiration
-S3Sign.url "http://s3.amazonaws.com/bucket/foo.png", 3600
+S3Sign.url "http://s3.amazonaws.com/bucket/foo.png", expires: 3600
 # => "https://bucket.s3.amazonaws.com/foo.png?AWSAccessKeyId=access_key_id&Expires=1427243780&Signature=a3RzDgElxDpSZLgxurZLiw1a6Ny%3D"
 
 # Pass a 'key' portion found under the bucket with default expiration
@@ -55,10 +55,10 @@ S3Sign.url "images/foo.png"
 The gem also provides a `S3Sign::Helper` module, useful to mixin to rails
 controllers.  It will add two helper methods to your controllers and views.
 
-`s3_signed_url_for_key` - Takes a key/url and optional expires
+`s3_signed_url_for_key` - Takes a key/url and options
 
-`stable_s3_signed_url` - Takes a url and optional reference time.  Used for
-generting signatures that expire in the far future year 2036.
+`stable_s3_signed_url` - Takes a url and options.  Used for
+generating signatures that expire in the far future year 2036.
 
 ## Contributing
 

data/lib/s3_sign.rb

@@ -12,17 +12,27 @@ module S3Sign
     end
   end
 
-  def self.url(s3_url, expires = SEVEN_DAYS)
+  def self.url(s3_url, options = {})
     s3 = AWS::S3.new
     bucket = s3.buckets[bucket_name]
 
     path = path_from_s3_url(s3_url)
 
-    AWS::S3::S3Object.new(bucket, path).url_for(:read, expires: expires).to_s
+    AWS::S3::S3Object.new(bucket, path).url_for(:read, build_options(options)).to_s
   end
 
   protected
 
+  def self.build_options(options)
+    { expires: options.fetch(:expires, SEVEN_DAYS) }.tap do |o|
+      attachment_filename = options[:attachment_filename]
+
+      if attachment_filename
+        o[:response_content_disposition] = "attachment; filename=#{attachment_filename}"
+      end
+    end
+  end
+
   def self.path_from_s3_url(s3_url)
     s3_url.sub(%r{^.+?/#{bucket_name}/}, '')
   end

data/lib/s3_sign/helper.rb

@@ -14,8 +14,9 @@ module S3Sign
 
     # A pure "time from now" signed s3 asset url.  Good for non-visual elements
     # like attachments, and not thumbnails, that don't have the same caching concerns
-    def s3_signed_url_for_key(key, expires_in = 86_400)
-      S3Sign.url key, expires_in
+    def s3_signed_url_for_key(key, options = {})
+      options[:expires] ||= 86_400
+      S3Sign.url key, options
     end
 
     # Uses a far-future date so that the expires and signature on
@@ -33,10 +34,10 @@ module S3Sign
     # far future stable year.  This is useful to cache-bust the url from
     # an updated_at timestamp where some browsers/proxies may try to use
     # the cached asset even though it was updated.
-    def stable_s3_signed_url(url, reference_time = nil)
+    def stable_s3_signed_url(url, options = {})
       @stable_s3_expire_at ||= Time.parse("2036-1-1 00:00:00 UTC")
 
-      if reference_time
+      if reference_time = options.delete(:expires)
         # The time given but in the year 2036
         year       = @stable_s3_expire_at.year
         expires_at = Time.parse(reference_time.utc.strftime("#{year}-%m-%d %T UTC"))
@@ -44,7 +45,7 @@ module S3Sign
         expires_at = @stable_s3_expire_at
       end
 
-      s3_signed_url_for_key(url, expires_at)
+      s3_signed_url_for_key(url, expires: expires_at)
     end
   end
 end

data/lib/s3_sign/version.rb

@@ -1,3 +1,3 @@
 module S3Sign
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_sign
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brendon Murphy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk