shrine-google_cloud_storage 2.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa8300b784f31a4d398fc656917be9717fb7c05668de36ab15584bad9f85ff25
-  data.tar.gz: 967a2776f9f7246be332f21835478863b254ae9d55247ab14dafb61f715a378b
+  metadata.gz: cb917fe9e6635501eee44ec51a1d22260c4644db9e45693f2eb67fec80e5783c
+  data.tar.gz: bc5e261763d6e6f8bf2260e8d29f131709fa1fe6c88315f3eced62993270b807
 SHA512:
-  metadata.gz: f53205e5d15a03e3508ff5bf235017050b0281af87095f4643e7ab072cc909195391cd97144d577814274e78d4c547ff6d9e6f9afe8818d55087f71736105dd5
-  data.tar.gz: 81df0875f5f7ce14df49ebfb717aceecaa09c79134fe50c37b6b5fd7b1810c91c03a53221bb0484336bed9b4027d1bc9071c50ed104b007cf6dadceceffffa78
+  metadata.gz: fce36757f6eae8539ead0310cef964369d533d3b17a1ba26f04fb05af063a23aa65a1abb7db8074a6d16a1a7cda46579c72aadb53283da3e1e83087b294378e9
+  data.tar.gz: 80d104beac4587fcc85d2ece8e26b8c1332e57e4a78f3de5e4d4adf8cd3a0784cd35892c20da878495fcc8544f034dcedcc09a75573db96e39d7968bd81b73f2

data/README.md

@@ -12,8 +12,7 @@ gem "shrine-google_cloud_storage"
 
 ## Authentication
 
-The GCS plugin uses Google's [Project and Credential Lookup]. Please check
-documentation for the various ways to provide credentials.
+The GCS plugin uses the `google-cloud-storage` gem. Please refer to [its documentation for setting up authentication](https://googleapis.dev/ruby/google-cloud-storage/latest/file.AUTHENTICATION.html).
 
 ## Usage
 
@@ -66,7 +65,7 @@ cp .env.sample .env
 
 #### Option 2 - manual setup
 
-Create your own bucket and provide variables that allow for [project and credential lookup](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-storage/v1.6.0/guides/authentication#projectandcredentiallookup).
+Create your own bucket and provide variables that allow for [project and credential lookup](https://googleapis.dev/ruby/google-cloud-storage/latest/file.AUTHENTICATION.html#project-and-credential-lookup).
 For example:
 
 ```sh
@@ -97,4 +96,3 @@ GCS_DEBUG=true
 
 [Google Cloud Storage]: https://cloud.google.com/storage/
 [Shrine]: https://github.com/shrinerb/shrine
-[Project and Credential Lookup]: http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-storage/master/guides/authentication#projectandcredentiallookup

data/lib/shrine/storage/google_cloud_storage.rb

@@ -10,7 +10,7 @@ class Shrine
       # Initialize a Shrine::Storage for GCS allowing for auto-discovery of the Google::Cloud::Storage client.
       # @param [String] project Provide if not using auto discovery
       # @see http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-storage/v1.6.0/guides/authentication#environmentvariables for information on discovery
-      def initialize(project: nil, bucket:, prefix: nil, host: nil, default_acl: nil, object_options: {})
+      def initialize(project: nil, bucket:, prefix: nil, host: nil, default_acl: nil, object_options: {}, credentials: nil)
         @project = project
         @bucket = bucket
         @prefix = prefix
@@ -18,6 +18,7 @@ class Shrine
         @default_acl = default_acl
         @object_options = object_options
         @storage = nil
+        @credentials = credentials
       end
 
       # If the file is an UploadFile from GCS, issues a copy command, otherwise it uploads a file.
@@ -29,7 +30,7 @@ class Shrine
           file = existing_file.copy(
               @bucket, # dest_bucket_or_path - the bucket to copy the file to
               object_name(id), # dest_path - the path to copy the file to in the given bucket
-              acl: @default_acl
+              acl: options.fetch(:acl) { @default_acl }
           ) do |f|
             # Workaround a bug in File#copy where the content-type is not copied if you provide a block
             # See https://github.com/renchap/shrine-google_cloud_storage/issues/36
@@ -44,55 +45,53 @@ class Shrine
           file
         else
           with_file(io) do |file|
-              get_bucket.create_file(
-                  file,
-                  object_name(id), # path
-                  @object_options.merge(
-                      content_type: shrine_metadata["mime_type"],
-                      acl: @default_acl
-                  ).merge(options)
-              )
+            file_options = @object_options.merge(
+              content_type: shrine_metadata["mime_type"],
+              acl: options.fetch(:acl) { @default_acl }
+            ).merge(options)
+
+            get_bucket.create_file(
+                file,
+                object_name(id), # path
+                **file_options
+            )
           end
         end
       end
 
       # URL to the remote file, accepts options for customizing the URL
       def url(id, **options)
-        if options.key? :expires
-          signed_url = storage.signed_url(@bucket, object_name(id), options)
+        if @default_acl == 'publicRead'
+          host = @host || "storage.googleapis.com/#{@bucket}"
+          "https://#{host}/#{URI.encode_www_form_component(object_name(id))}"
+        else
+          signed_url = storage.signed_url(@bucket, object_name(id), **options)
           signed_url.gsub!(/storage.googleapis.com\/#{@bucket}/, @host) if @host
           signed_url
-        else
-          host = @host || "storage.googleapis.com/#{@bucket}"
-          "https://#{host}/#{object_name(id)}"
         end
       end
 
-      # Downloads the file from GCS, and returns a `Tempfile`.
-      def download(id)
-        tempfile = Tempfile.new(["googlestorage", File.extname(id)], binmode: true)
-        get_file(id).download tempfile.path
-        tempfile.tap(&:open)
-      end
-
       # Opens the remote file and returns it as `Down::ChunkedIO` object.
       # @return [Down::ChunkedIO] object
       # @see https://github.com/janko-m/down#downchunkedio
-      def open(id)
+      def open(id, rewindable: true, **options)
         file = get_file(id)
 
+        raise Shrine::FileNotFound, "file #{id.inspect} not found on storage" unless file
+
         # create enumerator which lazily yields chunks of downloaded content
         chunks = Enumerator.new do |yielder|
           # trick to get google client to stream the download
           proc_io = ProcIO.new { |data| yielder << data }
-          file.download(proc_io, verify: :none)
+          file.download(proc_io, verify: :none, **options)
         end
 
         # wrap chunks in an IO-like object which downloads when needed
         Down::ChunkedIO.new(
-          chunks: chunks,
-          size:   file.size,
-          data:   { file: file }
+          chunks:     chunks,
+          size:       file.size,
+          rewindable: rewindable,
+          data:       { file: file },
         )
       end
 
@@ -154,11 +153,13 @@ class Shrine
 
       # @see http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-storage/v1.6.0/guides/authentication
       def storage
-        @storage ||= if @project.nil?
-                       Google::Cloud::Storage.new
-                     else
-                       Google::Cloud::Storage.new(project: @project)
-                     end
+        return @storage if @storage
+
+        opts = {}
+        opts[:project] = @project if @project
+        opts[:credentials] = @credentials if @credentials
+
+        @storage = Google::Cloud::Storage.new(**opts)
       end
 
       def copyable?(io)

data/shrine-google_cloud_storage.gemspec

@@ -1,23 +1,30 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-google_cloud_storage"
-  gem.version       = "2.0.1"
+  gem.version       = "3.2.0"
 
-  gem.required_ruby_version = ">= 2.1"
+  gem.required_ruby_version = ">= 2.6"
 
   gem.summary      = "Provides Google Cloud Storage storage for Shrine."
   gem.homepage     = "https://github.com/renchap/shrine-google_cloud_storage"
   gem.authors      = ["Renaud Chaput"]
   gem.email        = ["renchap@gmail.com"]
   gem.license      = "MIT"
+  gem.metadata     = {
+                       "bug_tracker_uri"       => "https://github.com/renchap/shrine-google_cloud_storage/issues",
+                       "changelog_uri"         => "https://github.com/renchap/shrine-google_cloud_storage/blob/main/CHANGELOG.md",
+                       "homepage_uri"          => "https://github.com/renchap/shrine-google_cloud_storage/",
+                       "source_code_uri"       => "https://github.com/renchap/shrine-google_cloud_storage/",
+                       "rubygems_mfa_required" => "true",
+                     }
 
   gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine-google_cloud_storage.gemspec"]
   gem.require_path = "lib"
 
-  gem.add_dependency "shrine", "~> 2.11"
+  gem.add_dependency "shrine", "~> 3.0"
   gem.add_dependency "google-cloud-storage", "~> 1.6"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"
   gem.add_development_dependency "dotenv"
-  gem.add_development_dependency "http", "~> 4.0"
+  gem.add_development_dependency "http", "~> 5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-google_cloud_storage
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Renaud Chaput
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: google-cloud-storage
   requirement: !ruby/object:Gem::Requirement
@@ -86,15 +86,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-description: 
+        version: '5.0'
+description:
 email:
 - renchap@gmail.com
 executables: []
@@ -107,8 +107,13 @@ files:
 homepage: https://github.com/renchap/shrine-google_cloud_storage
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/renchap/shrine-google_cloud_storage/issues
+  changelog_uri: https://github.com/renchap/shrine-google_cloud_storage/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/renchap/shrine-google_cloud_storage/
+  source_code_uri: https://github.com/renchap/shrine-google_cloud_storage/
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,15 +121,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Provides Google Cloud Storage storage for Shrine.
 test_files: []