google-cloud-storage 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52575f5ef15af2995be2e3b8598cc5bfae8d96468b1f56d2eb218f1ea53f4091
-  data.tar.gz: 5bbda2deb2729b4fb0046ae968d16ee22019363acf9ed511f43e36a3631d2f0e
+  metadata.gz: a70c28bc015c2cde33d22c6af7ad022c4168fd32be38037a18f55e771780b866
+  data.tar.gz: 35c072fa504c5b0d3fd9984765a5049d41d7169755afeadc9e6554d74bb6b3e3
 SHA512:
-  metadata.gz: 7a7af41ef5155e1d9e272f7402194baef5559fdba501cc0c64e8bc17c276ac9a0c965b8772e422eb360d668344e8e83b4b6128b1a25cfa84a2d6c17eec7f8e7c
-  data.tar.gz: 6b31863d501097f76334100889953e02e3f3e643737fbca51c976317dc37c2cf06ba370f1e50d577e7dc3c46978b8bd270eb4d4c9f3f35430bed992c79ce1d36
+  metadata.gz: aa389bb4e5790362bec4d6376e72fd216739d44912c0d3254eb25dde0c83dfbf7ba02ba90ebd94c5d9b3c600bac0cc7c2c62e80128e59388a6426e04e2d21bf7
+  data.tar.gz: 85189ae6d33e7e4e95d42217d7a3aa90e44725c442b0ac912a937b314f27f6b333a3c6b566ffa1d3406f8f8388e2f27665a58174383275ddc5d81d7292c955cc

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History
 
+### 1.24.0 / 2019-11-12
+
+#### Features
+
+* Add force_copy_metadata to File#copy and #rewrite
+
+#### Bug Fixes
+
+* Update #post_object to support special variable ${filename}
+
 ### 1.23.0 / 2019-11-05
 
 #### Features

data/lib/google/cloud/storage/file.rb

@@ -777,7 +777,7 @@ module Google
         end
 
         ##
-        # Download the file's contents to a local file or an File-like object.
+        # Downloads the file's contents to a local file or an File-like object.
         #
         # By default, the download is verified by calculating the MD5 digest.
         #
@@ -951,7 +951,15 @@ module Google
         end
 
         ##
-        # Copy the file to a new location.
+        # Copies the file to a new location. Metadata excluding ACL from the source
+        # object will be copied to the destination object unless a block is provided.
+        #
+        # If an optional block for updating is provided, only the updates made in
+        # this block will appear in the destination object, and other metadata
+        # fields in the destination object will not be copied. To copy the other
+        # source file metadata fields while updating destination fields in a
+        # block, use the `force_copy_metadata: true` flag, and the client library
+        # will copy metadata from source metadata into the copy request.
         #
         # If a [customer-supplied encryption
         # key](https://cloud.google.com/storage/docs/encryption#customer-supplied)
@@ -986,6 +994,19 @@ module Google
         # @param [String] encryption_key Optional. The customer-supplied,
         #   AES-256 encryption key used to encrypt the file, if one was provided
         #   to {Bucket#create_file}.
+        # @param [Boolean] force_copy_metadata Optional. If `true` and if updates
+        #   are made in a block, the following fields will be copied from the
+        #   source file to the destination file (except when changed by updates):
+        #
+        #   * `cache_control`
+        #   * `content_disposition`
+        #   * `content_encoding`
+        #   * `content_language`
+        #   * `content_type`
+        #   * `metadata`
+        #
+        #   If `nil` or `false`, only the updates made in the yielded block will
+        #   be applied to the destination object. The default is `nil`.
         # @yield [file] a block yielding a delegate object for updating
         #
         # @return [Google::Cloud::Storage::File]
@@ -1035,12 +1056,13 @@ module Google
         #     f.metadata["copied_from"] = "#{file.bucket}/#{file.name}"
         #   end
         #
-        def copy dest_bucket_or_path, dest_path = nil,
-                 acl: nil, generation: nil, encryption_key: nil
+        def copy dest_bucket_or_path, dest_path = nil, acl: nil, generation: nil, encryption_key: nil,
+                 force_copy_metadata: nil
           rewrite dest_bucket_or_path, dest_path,
                   acl: acl, generation: generation,
                   encryption_key: encryption_key,
-                  new_encryption_key: encryption_key do |updater|
+                  new_encryption_key: encryption_key,
+                  force_copy_metadata: force_copy_metadata do |updater|
             yield updater if block_given?
           end
         end
@@ -1048,7 +1070,15 @@ module Google
         ##
         # [Rewrites](https://cloud.google.com/storage/docs/json_api/v1/objects/rewrite)
         # the file to a new location. Or the same location can be provided to
-        # rewrite the file in place.
+        # rewrite the file in place. Metadata from the source object will
+        # be copied to the destination object unless a block is provided.
+        #
+        # If an optional block for updating is provided, only the updates made in
+        # this block will appear in the destination object, and other metadata
+        # fields in the destination object will not be copied. To copy the other
+        # source file metadata fields while updating destination fields in a
+        # block, use the `force_copy_metadata: true` flag, and the client library
+        # will copy metadata from source metadata into the copy request.
         #
         # If a [customer-supplied encryption
         # key](https://cloud.google.com/storage/docs/encryption#customer-supplied)
@@ -1096,6 +1126,19 @@ module Google
         #   the same location as the bucket.The Service Account associated with
         #   your project requires access to this encryption key. Do not provide
         #   if `new_encryption_key` is used.
+        # @param [Boolean] force_copy_metadata Optional. If `true` and if updates
+        #   are made in a block, the following fields will be copied from the
+        #   source file to the destination file (except when changed by updates):
+        #
+        #   * `cache_control`
+        #   * `content_disposition`
+        #   * `content_encoding`
+        #   * `content_language`
+        #   * `content_type`
+        #   * `metadata`
+        #
+        #   If `nil` or `false`, only the updates made in the yielded block will
+        #   be applied to the destination object. The default is `nil`.
         # @yield [file] a block yielding a delegate object for updating
         #
         # @return [Google::Cloud::Storage::File]
@@ -1189,21 +1232,20 @@ module Google
         #     f.metadata["rewritten_from"] = "#{file.bucket}/#{file.name}"
         #   end
         #
-        def rewrite dest_bucket_or_path, dest_path = nil,
-                    acl: nil, generation: nil,
-                    encryption_key: nil, new_encryption_key: nil,
-                    new_kms_key: nil
+        def rewrite dest_bucket_or_path, dest_path = nil, acl: nil, generation: nil, encryption_key: nil,
+                    new_encryption_key: nil, new_kms_key: nil, force_copy_metadata: nil
           ensure_service!
           dest_bucket, dest_path = fix_rewrite_args dest_bucket_or_path,
                                                     dest_path
 
           update_gapi = nil
           if block_given?
-            updater = Updater.new gapi
+            updater = Updater.new gapi.dup
             yield updater
             updater.check_for_changed_metadata!
             if updater.updates.any?
-              update_gapi = gapi_from_attrs updater.updates
+              attributes = force_copy_metadata ? (Updater::COPY_ATTRS + updater.updates).uniq : updater.updates
+              update_gapi = self.class.gapi_from_attrs updater.gapi, attributes
             end
           end
 
@@ -1678,6 +1720,21 @@ module Google
           end
         end
 
+        ##
+        # @private
+        #
+        def self.gapi_from_attrs gapi, attributes
+          attributes.flatten!
+          return nil if attributes.empty?
+          attr_params = Hash[attributes.map do |attr|
+                               [attr, gapi.send(attr)]
+                             end]
+          # Sending nil metadata results in an Apiary runtime error:
+          # NoMethodError: undefined method `each' for nil:NilClass
+          attr_params.reject! { |k, v| k == :metadata && v.nil? }
+          Google::Apis::StorageV1::Object.new attr_params
+        end
+
         protected
 
         ##
@@ -1697,7 +1754,7 @@ module Google
         def update_gapi! *attributes
           attributes.flatten!
           return if attributes.empty?
-          update_gapi = gapi_from_attrs attributes
+          update_gapi = self.class.gapi_from_attrs @gapi, attributes
           return if update_gapi.nil?
 
           ensure_service!
@@ -1712,15 +1769,6 @@ module Google
                   end
         end
 
-        def gapi_from_attrs *attributes
-          attributes.flatten!
-          return nil if attributes.empty?
-          attr_params = Hash[attributes.map do |attr|
-            [attr, @gapi.send(attr)]
-          end]
-          Google::Apis::StorageV1::Object.new attr_params
-        end
-
         def rewrite_gapi bucket, name, updated_gapi,
                          new_bucket: nil, new_name: nil, acl: nil,
                          generation: nil, encryption_key: nil,
@@ -1791,7 +1839,21 @@ module Google
         # Yielded to a block to accumulate changes for a patch request.
         class Updater < File
           # @private
-          attr_reader :updates
+          attr_reader :updates, :gapi
+
+          ##
+          # @private
+          # Whitelist of Google::Apis::StorageV1::Object attributes to be
+          # copied when File#copy or File#rewrite is called with
+          # `force_copy_metadata: true`.
+          COPY_ATTRS = [
+            :cache_control,
+            :content_disposition,
+            :content_encoding,
+            :content_language,
+            :content_type,
+            :metadata
+          ].freeze
 
           ##
           # @private Create an Updater object.

data/lib/google/cloud/storage/file/signer_v2.rb

@@ -41,9 +41,20 @@ module Google
           end
 
           ##
-          # The external path to the file.
+          # The external path to the file, URI-encoded.
+          # Will not URI encode the special `${filename}` variable.
+          # "You can also use the ${filename} variable..."
+          # https://cloud.google.com/storage/docs/xml-api/post-object
+          #
           def ext_path
-            Addressable::URI.escape "/#{@bucket}/#{@path}"
+            path = "/#{@bucket}/#{@path}"
+            escaped = Addressable::URI.escape path
+            special_var = "${filename}"
+            # Restore the unencoded `${filename}` variable, if present.
+            if path.include? special_var
+              return escaped.gsub "$%7Bfilename%7D", special_var
+            end
+            escaped
           end
 
           ##

data/lib/google/cloud/storage/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Storage
-      VERSION = "1.23.0".freeze
+      VERSION = "1.24.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2019-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core