google-cloud-storage 1.9.0 → 1.10.0

data/lib/google/cloud/storage/bucket/cors.rb

@@ -1,10 +1,10 @@
-# Copyright 2015 Google Inc. All rights reserved.
+# Copyright 2015 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -125,7 +125,7 @@ module Google
               @origin = Array(origin)
               @methods = Array(methods)
               @headers = Array(headers)
-              @max_age = (max_age||1800)
+              @max_age = (max_age || 1800)
             end
 
             def to_gapi

data/lib/google/cloud/storage/bucket/list.rb

@@ -1,10 +1,10 @@
-# Copyright 2015 Google Inc. All rights reserved.
+# Copyright 2015 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -163,7 +163,7 @@ module Google
           ##
           # Raise an error unless an active connection is available.
           def ensure_service!
-            fail "Must have active connection" unless @service
+            raise "Must have active connection" unless @service
           end
         end
       end

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

@@ -1,10 +1,10 @@
-# Copyright 2014 Google Inc. All rights reserved.
+# Copyright 2014 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -38,19 +38,20 @@ module Google
       #   storage.project_id #=> "my-project"
       #
       class Credentials < Google::Auth::Credentials
-        SCOPE = ["https://www.googleapis.com/auth/devstorage.full_control"]
-        PATH_ENV_VARS = %w(STORAGE_CREDENTIALS
+        SCOPE = \
+          ["https://www.googleapis.com/auth/devstorage.full_control"].freeze
+        PATH_ENV_VARS = %w[STORAGE_CREDENTIALS
                            STORAGE_KEYFILE
                            GOOGLE_CLOUD_CREDENTIALS
                            GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(STORAGE_CREDENTIALS_JSON
+                           GCLOUD_KEYFILE].freeze
+        JSON_ENV_VARS = %w[STORAGE_CREDENTIALS_JSON
                            STORAGE_KEYFILE_JSON
                            GOOGLE_CLOUD_CREDENTIALS_JSON
                            GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON)
+                           GCLOUD_KEYFILE_JSON].freeze
         DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"]
+          ["~/.config/gcloud/application_default_credentials.json"].freeze
       end
     end
   end

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

@@ -1,10 +1,10 @@
-# Copyright 2014 Google Inc. All rights reserved.
+# Copyright 2014 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

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

@@ -1,10 +1,10 @@
-# Copyright 2014 Google Inc. All rights reserved.
+# Copyright 2014 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -13,11 +13,11 @@
 # limitations under the License.
 
 
-require "uri"
 require "google/cloud/storage/file/acl"
 require "google/cloud/storage/file/list"
 require "google/cloud/storage/file/verifier"
 require "google/cloud/storage/file/signer"
+require "zlib"
 
 module Google
   module Cloud
@@ -438,6 +438,13 @@ 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] skip_decompress Optional. If `true`, the data for a
+        #   Storage object returning a `Content-Encoding: gzip` response header
+        #   will *not* be automatically decompressed by this client library. The
+        #   default is `nil`. Note that all requests by this client library send
+        #   the `Accept-Encoding: gzip` header, so decompressive transcoding is
+        #   not performed in the Storage service. (See [Transcoding of
+        #   gzip-compressed files](https://cloud.google.com/storage/docs/transcoding))
         #
         # @return [IO] Returns an IO object representing the file data. This
         #   will ordinarily be a `::File` object referencing the local file
@@ -497,7 +504,7 @@ module Google
         #   downloaded.rewind
         #   downloaded.read #=> "Hello world!"
         #
-        # @example Download a public file with an unauthenticated client:
+        # @example Download a public file with an unauthenticated client.
         #   require "google/cloud/storage"
         #
         #   storage = Google::Cloud::Storage.anonymous
@@ -509,17 +516,49 @@ module Google
         #   downloaded.rewind
         #   downloaded.read #=> "Hello world!"
         #
-        def download path = nil, verify: :md5, encryption_key: nil
+        # @example Upload and download gzip-encoded file data.
+        #   require "zlib"
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   gz = StringIO.new ""
+        #   z = Zlib::GzipWriter.new gz
+        #   z.write "Hello world!"
+        #   z.close
+        #   data = StringIO.new gz.string
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   bucket.create_file data, "path/to/gzipped.txt",
+        #                      content_encoding: "gzip"
+        #
+        #   file = bucket.file "path/to/gzipped.txt"
+        #
+        #   # The downloaded data is decompressed by default.
+        #   file.download "path/to/downloaded/hello.txt"
+        #
+        #   # The downloaded data remains compressed with skip_decompress.
+        #   file.download "path/to/downloaded/gzipped.txt",
+        #                 skip_decompress: true
+        #
+        def download path = nil, verify: :md5, encryption_key: nil,
+                     skip_decompress: nil
           ensure_service!
           if path.nil?
             path = StringIO.new
             path.set_encoding "ASCII-8BIT"
           end
-          file = service.download_file \
+          file, resp = service.download_file \
             bucket, name, path, key: encryption_key, user_project: user_project
           # FIX: downloading with encryption key will return nil
           file ||= ::File.new(path)
           verify_file! file, verify
+          if !skip_decompress &&
+             Array(resp.header["Content-Encoding"]).include?("gzip")
+            file = gzip_decompress file
+          end
+          file
         end
 
         ##
@@ -774,7 +813,7 @@ module Google
         def public_url protocol: :https
           "#{protocol}://storage.googleapis.com/#{bucket}/#{name}"
         end
-        alias_method :url, :public_url
+        alias url public_url
 
         ##
         # Access without authentication can be granted to a File for a specified
@@ -977,7 +1016,7 @@ module Google
           @lazy = nil
           self
         end
-        alias_method :refresh!, :reload!
+        alias refresh! reload!
 
         ##
         # Determines whether the file exists in the Storage service.
@@ -1037,7 +1076,7 @@ module Google
         ##
         # Raise an error unless an active service is available.
         def ensure_service!
-          fail "Must have active connection" unless service
+          raise "Must have active connection" unless service
         end
 
         ##
@@ -1056,12 +1095,12 @@ module Google
 
           ensure_service!
 
-          if attributes.include? :storage_class
-            @gapi = rewrite_gapi bucket, name, update_gapi
-          else
-            @gapi = service.patch_file \
-              bucket, name, update_gapi, user_project: user_project
-          end
+          @gapi = if attributes.include? :storage_class
+                    rewrite_gapi bucket, name, update_gapi
+                  else
+                    service.patch_file \
+                      bucket, name, update_gapi, user_project: user_project
+                  end
         end
 
         def gapi_from_attrs *attributes
@@ -1107,6 +1146,26 @@ module Google
           file
         end
 
+        # @return [IO] Returns an IO object representing the file data. This
+        #   will either be a `::File` object referencing the local file
+        #   system or a StringIO instance.
+        def gzip_decompress local_file
+          if local_file.respond_to? :path
+            gz = ::File.open(Pathname(local_file).to_path, "rb") do |f|
+              Zlib::GzipReader.new(StringIO.new(f.read))
+            end
+            uncompressed_string = gz.read
+            ::File.open(Pathname(local_file).to_path, "w") do |f|
+              f.write uncompressed_string
+              f
+            end
+          else # local_file is StringIO
+            local_file.rewind
+            gz = Zlib::GzipReader.new StringIO.new(local_file.read)
+            StringIO.new gz.read
+          end
+        end
+
         def storage_class_for str
           return nil if str.nil?
           { "durable_reduced_availability" => "DURABLE_REDUCED_AVAILABILITY",

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

@@ -1,10 +1,10 @@
-# Copyright 2015 Google Inc. All rights reserved.
+# Copyright 2015 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -48,7 +48,7 @@ module Google
                     "project_private" => "projectPrivate",
                     "publicRead" => "publicRead",
                     "public" => "publicRead",
-                    "public_read" => "publicRead" }
+                    "public_read" => "publicRead" }.freeze
 
           ##
           # A boolean value or a project ID string to indicate the project to
@@ -101,7 +101,7 @@ module Google
             @owners  = entities_from_acls acls, "OWNER"
             @readers = entities_from_acls acls, "READER"
           end
-          alias_method :refresh!, :reload!
+          alias refresh! reload!
 
           ##
           # Lists the owners of the file.
@@ -303,10 +303,10 @@ module Google
           def auth!
             update_predefined_acl! "authenticatedRead"
           end
-          alias_method :authenticatedRead!, :auth!
-          alias_method :auth_read!, :auth!
-          alias_method :authenticated!, :auth!
-          alias_method :authenticated_read!, :auth!
+          alias authenticatedRead! auth!
+          alias auth_read! auth!
+          alias authenticated! auth!
+          alias authenticated_read! auth!
 
           ##
           # Convenience method to apply the `bucketOwnerFullControl` predefined
@@ -325,7 +325,7 @@ module Google
           def owner_full!
             update_predefined_acl! "bucketOwnerFullControl"
           end
-          alias_method :bucketOwnerFullControl!, :owner_full!
+          alias bucketOwnerFullControl! owner_full!
 
           ##
           # Convenience method to apply the `bucketOwnerRead` predefined ACL
@@ -344,7 +344,7 @@ module Google
           def owner_read!
             update_predefined_acl! "bucketOwnerRead"
           end
-          alias_method :bucketOwnerRead!, :owner_read!
+          alias bucketOwnerRead! owner_read!
 
           ##
           # Convenience method to apply the `private` predefined ACL
@@ -381,7 +381,7 @@ module Google
           def project_private!
             update_predefined_acl! "projectPrivate"
           end
-          alias_method :projectPrivate!, :project_private!
+          alias projectPrivate! project_private!
 
           ##
           # Convenience method to apply the `publicRead` predefined ACL
@@ -400,8 +400,8 @@ module Google
           def public!
             update_predefined_acl! "publicRead"
           end
-          alias_method :publicRead!, :public!
-          alias_method :public_read!, :public!
+          alias publicRead! public!
+          alias public_read! public!
 
           protected
 

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

@@ -1,10 +1,10 @@
-# Copyright 2015 Google Inc. All rights reserved.
+# Copyright 2015 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -182,7 +182,7 @@ module Google
           ##
           # Raise an error unless an active service is available.
           def ensure_service!
-            fail "Must have active connection" unless @service
+            raise "Must have active connection" unless @service
           end
         end
       end

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

@@ -1,10 +1,10 @@
-# Copyright 2017 Google Inc. All rights reserved.
+# Copyright 2017 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,6 +14,7 @@
 
 
 require "base64"
+require "cgi"
 require "openssl"
 require "google/cloud/storage/errors"
 
@@ -41,7 +42,10 @@ module Google
           ##
           # The external path to the file.
           def ext_path
-            URI.escape "/#{@bucket}/#{@path}"
+            escaped_path = String(@path).split("/").map do |node|
+              CGI.escape node
+            end.join("/")
+            "/#{CGI.escape @bucket}/#{escaped_path}"
           end
 
           ##
@@ -53,7 +57,7 @@ module Google
           def apply_option_defaults options
             adjusted_expires = (Time.now.utc + (options[:expires] || 300)).to_i
             options[:expires] = adjusted_expires
-            options[:method]  ||= "GET"
+            options[:method] ||= "GET"
             options
           end
 
@@ -81,12 +85,12 @@ module Google
             }
 
             p = options[:policy] || {}
-            fail "Policy must be given in a Hash" unless p.is_a? Hash
+            raise "Policy must be given in a Hash" unless p.is_a? Hash
 
             i = determine_issuer options
             s = determine_signing_key options
 
-            fail SignedUrlUnavailable unless i && s
+            raise SignedUrlUnavailable unless i && s
 
             policy_str = p.to_json
             policy = Base64.strict_encode64(policy_str).delete("\n")
@@ -106,7 +110,7 @@ module Google
             i = determine_issuer options
             s = determine_signing_key options
 
-            fail SignedUrlUnavailable unless i && s
+            raise SignedUrlUnavailable unless i && s
 
             sig = generate_signature s, signature_str(options)
             generate_signed_url i, sig, options[:expires], options[:query]
@@ -136,7 +140,7 @@ module Google
 
           def format_extension_headers headers
             return "" if headers.nil?
-            fail "Headers must be given in a Hash" unless headers.is_a? Hash
+            raise "Headers must be given in a Hash" unless headers.is_a? Hash
             flatten = headers.map do |key, value|
               "#{key.to_s.downcase}:#{value.gsub(/\s+/, ' ')}\n"
             end

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

@@ -1,10 +1,10 @@
-# Copyright 2014 Google Inc. All rights reserved.
+# Copyright 2014 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -30,17 +30,15 @@ module Google
           def self.verify_md5! gcloud_file, local_file
             gcloud_digest = gcloud_file.md5
             local_digest = md5_for local_file
-            if gcloud_digest != local_digest
-              fail FileVerificationError.for_md5(gcloud_digest, local_digest)
-            end
+            return if gcloud_digest == local_digest
+            raise FileVerificationError.for_md5(gcloud_digest, local_digest)
           end
 
           def self.verify_crc32c! gcloud_file, local_file
             gcloud_digest = gcloud_file.crc32c
             local_digest = crc32c_for local_file
-            if gcloud_digest != local_digest
-              fail FileVerificationError.for_crc32c(gcloud_digest, local_digest)
-            end
+            return if gcloud_digest == local_digest
+            raise FileVerificationError.for_crc32c(gcloud_digest, local_digest)
           end
 
           def self.verify_md5 gcloud_file, local_file
@@ -58,7 +56,9 @@ module Google
               end
             else # StringIO
               local_file.rewind
-              ::Digest::MD5.base64digest local_file.read
+              md5 = ::Digest::MD5.base64digest local_file.read
+              local_file.rewind
+              md5
             end
           end
 
@@ -69,7 +69,9 @@ module Google
               end
             else # StringIO
               local_file.rewind
-              ::Digest::CRC32c.base64digest local_file.read
+              crc32c = ::Digest::CRC32c.base64digest local_file.read
+              local_file.rewind
+              crc32c
             end
           end
         end