shrine-google_cloud_storage 1.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1076839610e614727ac6be9742ee1ec630112f7
-  data.tar.gz: 638f6ad6360e4f65ef6db03ca5a0fbd8fa5e6c75
+SHA256:
+  metadata.gz: 4e2812d047499cf034bc9683bef6c308ba85483e40e07f2745d8603b6d5f820b
+  data.tar.gz: 88260f377b2ea8f7268610467f6f4be5bfb9e03995f992abc97f5dc888ae62b1
 SHA512:
-  metadata.gz: '01968d677153ad556ea301f30149813fee671e094ce1c2744d3fbe9ba59b8f0a85f032d7ce12ef9469c8be8809b36a96ffbb80c51b93dbb7dfe5abf7ea8ca0b2'
-  data.tar.gz: '060239c68bea2b0bba944991ec369bd73b32c6c8c87650ba26dc9d31168092a27ace43aa01af2f7a21f445ebecae406572ed859f40d212500c8f9d0917eb8268'
+  metadata.gz: e0dbe54c3cb323ea666e97701690367346f71616c821e3eb5b2e6dfc128258e1127f13b026504c4d88dfbdf4448bae78a601222305a2686b96baec0512832309
+  data.tar.gz: '058d11b912b501fb42a2649d83d90345f0bb3090dd3f7f1adaa9ea01b71685faf723acc164d958e3639b2eecd8baa20916a5280dcf2a295f52ca50d787701fea'

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](http://googleapis.github.io/google-cloud-ruby/docs/google-cloud-storage/latest/file.AUTHENTICATION.html).
 
 ## Usage
 
@@ -96,5 +95,4 @@ GCS_DEBUG=true
 [MIT](http://opensource.org/licenses/MIT)
 
 [Google Cloud Storage]: https://cloud.google.com/storage/
-[Shrine]: https://github.com/janko-m/shrine
-[Project and Credential Lookup]: http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-storage/master/guides/authentication#projectandcredentiallookup
+[Shrine]: https://github.com/shrinerb/shrine

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,8 +30,13 @@ 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
+            # See https://github.com/googleapis/google-cloud-ruby/issues/4254
+            f.content_type = existing_file.content_type
+
             # update the additional options
             @object_options.merge(options).each_pair do |key, value|
               f.send("#{key}=", value)
@@ -38,21 +44,25 @@ class Shrine
           end
           file
         else
-          get_bucket.create_file(
-              prepare_io(io), # file -  IO object, or IO-ish object like StringIO
-              object_name(id), # path
-              @object_options.merge(
-                  content_type: shrine_metadata["mime_type"],
-                  acl: @default_acl
-              ).merge(options)
-          )
+          with_file(io) do |file|
+            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)
+          signed_url = storage.signed_url(@bucket, object_name(id), **options)
           signed_url.gsub!(/storage.googleapis.com\/#{@bucket}/, @host) if @host
           signed_url
         else
@@ -61,31 +71,27 @@ class Shrine
         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
 
@@ -99,31 +105,36 @@ class Shrine
       # deletes the file from the storage
       def delete(id)
         file = get_file(id)
-        file.delete unless file.nil?
+        delete_file(file) unless file.nil?
       end
 
-      # Otherwise deletes all objects from the storage.
-      def clear!
+      # deletes all objects from the storage
+      # If block is givem, deletes only objects for which
+      # the block evaluates to true.
+      #
+      # clear!
+      # # or
+      # clear! { |file| file.updated_at < 1.week.ago }
+      def clear!(&block)
         prefix = "#{@prefix}/" if @prefix
         files = get_bucket.files prefix: prefix
-        batch_delete(files.lazy.map(&:name))
+
         loop do
-          break if !files.next?
-          batch_delete(files.next.lazy.map(&:name))
+          files.each { |file| delete_file(file) if block.nil? || block.call(file) }
+          files = files.next or break
         end
       end
 
+      # returns request data (:method, :url, and :headers) for direct uploads
       def presign(id, **options)
+        url = storage.signed_url(@bucket, object_name(id), method: "PUT", **options)
+
         headers = {}
         headers["Content-Type"] = options[:content_type] if options[:content_type]
         headers["Content-MD5"]  = options[:content_md5] if options[:content_md5]
         headers.merge!(options[:headers]) if options[:headers]
 
-        OpenStruct.new(
-          url: storage.signed_url(@bucket, object_name(id), method: "PUT", **options),
-          fields: {},
-          headers: headers
-        )
+        { method: :put, url: url, headers: headers }
       end
 
       def object_name(id)
@@ -142,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)
@@ -155,27 +168,20 @@ class Shrine
         # TODO: add a check for the credentials
       end
 
-      # Google cloud storage client only accepts IO|IOString|Tempfile instances
-      # or else it will raise a "Google::Apis::ClientError, 'Invalid upload source"
-      #
-      # We need to convert our file to an IO.
-      j
-      # see:
-      # https://github.com/google/google-api-ruby-client/blob/1c2cf5d57fd5e606c03f2aecab88469f46b8f3b2/lib/google/apis/core/upload.rb#L77
-      def prepare_io(io)
-        if io.respond_to?(:to_io)
-          io.to_io
-        elsif io.respond_to?(:tempfile)
-          io.tempfile
+      def with_file(io)
+        if io.respond_to?(:tempfile) # ActionDispatch::Http::UploadedFile
+          yield io.tempfile
         else
-          io
+          Shrine.with_file(io) { |file| yield file }
         end
       end
 
-      def batch_delete(object_names)
-        bucket = get_bucket
-        object_names.each do |name|
-          bucket.file(name).delete
+      # deletes file with ignoring NotFoundError
+      def delete_file(file)
+        begin
+          file.delete
+        rescue Google::Cloud::NotFoundError
+          # we're fine if the file was already deleted
         end
       end
 

data/shrine-google_cloud_storage.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-google_cloud_storage"
-  gem.version       = "1.0.1"
+  gem.version       = "3.1.0"
 
   gem.required_ruby_version = ">= 2.1"
 
@@ -13,11 +13,11 @@ Gem::Specification.new do |gem|
   gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine-google_cloud_storage.gemspec"]
   gem.require_path = "lib"
 
-  gem.add_dependency "shrine", "~> 2.0"
+  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", "~> 3.0"
+  gem.add_development_dependency "http", "~> 4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-google_cloud_storage
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Renaud Chaput
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        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: '3.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: 
+        version: '4.0'
+description:
 email:
 - renchap@gmail.com
 executables: []
@@ -108,7 +108,7 @@ homepage: https://github.com/renchap/shrine-google_cloud_storage
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,9 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Provides Google Cloud Storage storage for Shrine.
 test_files: []