shrine-fog 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18afd919594ff4a696493cc3088ea1a76fc1f84d9da3a5abf929b44c4782bcee
-  data.tar.gz: 96484cd28138fb048e7c3663dfd825ed07c83cd72eacf9c554255c90200062fc
+  metadata.gz: 1b3228745b8294ae999e783d9e5547be47cf31c67d5dd9ad40f98133b5739ff9
+  data.tar.gz: b5882ca2581c9adf8ec8570c4f758d9ec89f1c958a5c8a657f4fdf3b70b5d54d
 SHA512:
-  metadata.gz: 541a93eb5c0f74ee9fcdc04d43dc9e0d787f928a01f514343236c378a65016c85354cf4ecf4260a6fd78fc09a3ca74fef039985c8fa0c9ebc3d7f84a15bb8d2d
-  data.tar.gz: ec0f703e43d33c258c554b317b34fe467c39583b0eba1b83e0579481342a382dac699cb1c085aed2145e4f9fa599eb6ab04830d0aed2425aa154e8c5416a81ba
+  metadata.gz: 7a82144eeb24089ea7a6b4d9e9b96b226a305e52459982e183647ba8068fe62d29409e2616a0a2f40740501c76fda704cd25c1538aff39e1028008f4c8aef30d
+  data.tar.gz: '087f8ca4c9325a74eb5a13fc428be94cd7094023914ae7c394265b58d462d7c2cb8b81429cd3ac960390b39dd3dd9e0a60a1ab73b32ba5989a99510ff536b058'

data/README.md

@@ -52,23 +52,43 @@ instead of reuploaded.
 
 ### URLs
 
-By default the shrine-fog will generate public unsigned URLs, but if you want
-to change that tell Fog not to store files publicly, you can set `:public` to
-false:
+By default shrine-fog will generate signed expiring URLs.
 
 ```rb
-fog = Shrine::Storage::Fog.new(**fog_options)
-fog.url("image.jpg") #=> "https://my-bucket.s3-eu-west-1.amazonaws.com/image.jpg"
+uploaded_file.url("image.jpg") #=> "https://my-bucket.s3-eu-west-1.amazonaws.com/foo?X-Amz-Expires=3600&X-Amz-Date=20151217T102105Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIJF55TMZZY45UT6Q/20151217/eu-west-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=6908d8cd85ce4469f141a36955611f26d29ae7919eb8a6cba28f9194a92d96c3"
+```
+
+You can modify the URL expiration date via `:expires` (the default is `3600`):
+
+```rb
+uploaded_file.url("image.jpg", expires: 90) #=> "https://my-bucket.s3-eu-west-1.amazonaws.com/foo?X-Amz-Expires=90&X-Amz-Date=20151217T102105Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIJF55TMZZY45UT6Q/20151217/eu-west-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=6908d8cd85ce4469f141a36955611f26d29ae7919eb8a6cba28f9194a92d96c3"
+```
+
+If the files you're uploading are public readable (e.g. you're passing the
+correct ACL on upload, `acl: "publicRead"` for fog-google), and you want to
+generate public URLs, you can pass `public: true` to `#url`:
+
+```rb
+uploaded_file.url("image.jpg", public: true) #=> "https://my-bucket.s3-eu-west-1.amazonaws.com/image.jpg"
+```
+
+Any additional URL options will be forwarded directly to the provider's
+`File#url` method.
+
+You can use the `default_url_options` Shrine plugin to set default URL options.
 
-fog = Shrine::Storage::Fog.new(public: false, **fog_options)
-fog.url("image.jpg") #=> "https://my-bucket.s3-eu-west-1.amazonaws.com/foo?X-Amz-Expires=3600&X-Amz-Date=20151217T102105Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIJF55TMZZY45UT6Q/20151217/eu-west-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=6908d8cd85ce4469f141a36955611f26d29ae7919eb8a6cba28f9194a92d96c3"
+### Upload options
+
+Dynamic upload options can be passed via the `upload_options` plugin:
+
+```rb
+Shrine.plugin :upload_options, store: { acl: "publicRead" }
 ```
 
-The signed URLs by default expire in 1 hour, you set `:expires` to number of
-seconds you want the URL to expire:
+You can also specify default upload options on storage initialization:
 
 ```rb
-Shrine::Storage::Fog.new(expires: 24*60*60, **fog_options) # expires in 1 day
+Shrine::Storage::Fog.new(upload_options: { acl: "publicRead" }, **options)
 ```
 
 ### S3 or Filesystem

data/lib/shrine/storage/fog.rb

@@ -7,12 +7,11 @@ class Shrine
     class Fog
       attr_reader :connection, :directory, :prefix
 
-      def initialize(directory:, prefix: nil, public: true, expires: 3600, connection: nil, **options)
+      def initialize(directory:, prefix: nil, connection: nil, upload_options: {}, **options)
         @connection = connection || ::Fog::Storage.new(options)
         @directory = @connection.directories.new(key: directory)
         @prefix = prefix
-        @public = public
-        @expires = expires
+        @upload_options = upload_options
       end
 
       def upload(io, id, **upload_options)
@@ -35,10 +34,11 @@ class Shrine
         file(id).destroy
       end
 
-      def url(id, **options)
-        signed_url = file(id).url(Time.now + @expires, **options)
-        if @public
-          uri = URI(signed_url)
+      def url(id, public: false, expires: 3600, **options)
+        signed_url = file(id).url(Time.now.utc + expires, *[**options])
+
+        if public
+          uri = URI.parse(signed_url)
           uri.query = nil
           uri.to_s
         else
@@ -79,11 +79,11 @@ class Shrine
       end
 
       def put(io, id, shrine_metadata: {}, **upload_options)
-        options = {key: path(id), body: io, public: @public}
-        options[:content_type] = shrine_metadata["mime_type"]
+        options = { content_type: shrine_metadata["mime_type"] }
+        options.update(@upload_options)
         options.update(upload_options)
 
-        directory.files.create(options)
+        directory.files.create(key: path(id), body: io, **options)
       end
 
       def copy(io, id, **upload_options)

data/shrine-fog.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name         = "shrine-fog"
-  gem.version      = "1.1.0"
+  gem.version      = "2.0.0"
 
   gem.required_ruby_version = ">= 2.1"
 
@@ -14,9 +14,9 @@ Gem::Specification.new do |gem|
   gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "*.gemspec"]
   gem.require_path = "lib"
 
-  gem.add_dependency "shrine", "~> 2.2"
+  gem.add_dependency "shrine", ">= 2.2", "< 4"
   gem.add_dependency "down", "~> 4.4"
-  gem.add_dependency "http", "~> 3.2"
+  gem.add_dependency "http", ">= 3.2", "< 5"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "fog-aws"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: shrine-fog
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-29 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: down
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +48,22 @@ dependencies:
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -152,8 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides Fog storage for Shrine.