google-cloud-storage 1.51.0 → 1.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3669f3114435c5da604ee4cc83bd776043d7e27f58922eb20a22916a9c5035b
-  data.tar.gz: fac7ade9b2aaffb42815c93ce0e32b23f95f984191b3704bda72fcc522f7a68e
+  metadata.gz: 67fa1effce117003750f759eba79de92380616365652f2a19ba49b1986c75634
+  data.tar.gz: 9729e6dc51f15a9a5e2e0370771f980908f9d6284973503c9c4d4c1e561b8d84
 SHA512:
-  metadata.gz: 3d2a78592e25e219f3a578488ecf2f56192402a4ec17d29729230c9da6a9198f7da91b0c1f565269d0d265af988f6f66b0b855fcdde296018119c43a4c29bf53
-  data.tar.gz: 90ca5c138c3e780001fa2f30be1b52fd3104a9160cc248a4bc88d31391a34b00d8fbb063c2e0609f72df72db7ee1769603b88500d0b6890235e3bb5e0c3a066b
+  metadata.gz: ec9022c921c0714ebf7f47131c745c113bb0480a34a376ca10055ccdee024821a518d1a87f742486118d7fb3e570beaeef5746f12676d5790e6ae697439dabd9
+  data.tar.gz: d5e57fd75d565a8328cf79ce42374883e4da7f875c7fd9571e928f9648c05578bee5743d68465819f3e5d488469d277749aecebd44810198fd1a1ca0cac6f3c3

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Release History
 
+### 1.54.0 (2024-12-11)
+
+#### Features
+
+* Updated required Ruby version to 3.0 or later ([#27599](https://github.com/googleapis/google-cloud-ruby/issues/27599)) 
+
+### 1.53.0 (2024-12-04)
+
+#### Features
+
+* add integration test for universe domain ([#27384](https://github.com/googleapis/google-cloud-ruby/issues/27384)) 
+* fetch file and bucket details from url ([#27322](https://github.com/googleapis/google-cloud-ruby/issues/27322)) 
+
+### 1.52.0 (2024-05-31)
+
+#### Features
+
+* support for hierarchical namespace (folders) ([#25967](https://github.com/googleapis/google-cloud-ruby/issues/25967)) 
+
 ### 1.51.0 (2024-04-25)
 
 #### Features

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

@@ -182,7 +182,7 @@ module Google
               @origin = Array(origin)
               @methods = Array(methods)
               @headers = Array(headers)
-              @max_age = (max_age || 1800)
+              @max_age = max_age || 1800
             end
 
             # @private
@@ -195,7 +195,7 @@ module Google
 
             # @private
             def self.from_gapi gapi
-              new gapi.origin.dup, gapi.http_method.dup, \
+              new gapi.origin.dup, gapi.http_method.dup,
                   headers: gapi.response_header.dup,
                   max_age: gapi.max_age_seconds
             end

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

@@ -1253,6 +1253,62 @@ module Google
           patch_gapi! :soft_delete_policy
         end
 
+        ##
+        # The bucket's hierarchical namespace (Folders) configuration.
+        # This value can be modified by calling {#hierarchical_namespace=}.
+        #
+        # @return [Google::Apis::StorageV1::Bucket::HierarchicalNamespace]
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   bucket.hierarchical_namespace
+        #
+        def hierarchical_namespace
+          @gapi.hierarchical_namespace
+        end
+
+        ##
+        # Sets the value of Hierarchical Namespace (Folders) for the bucket.
+        # This can only be enabled at bucket create time. If this is enabled,
+        # Uniform Bucket-Level Access must also be enabled.
+        # This value can be queried by calling {#hierarchical_namespace}.
+        #
+        # @param [Google::Apis::StorageV1::Bucket::HierarchicalNamespace,
+        #         Hash(String => String)] new_hierarchical_namespace The
+        #         bucket's new Hierarchical Namespace Configuration.
+        #
+        # @example Enabled Hierarchical Namespace using HierarchicalNamespace class:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   hierarchical_namespace = Google::Apis::StorageV1::Bucket::HierarchicalNamespace.new
+        #   hierarchical_namespace.enabled = true
+        #
+        #   bucket.hierarchical_namespace = hierarchical_namespace
+        #
+        # @example Disable Hierarchical Namespace using Hash:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   hierarchical_namespace = { enabled: false }
+        #   bucket.hierarchical_namespace = hierarchical_namespace
+        #
+        def hierarchical_namespace= new_hierarchical_namespace
+          @gapi.hierarchical_namespace = new_hierarchical_namespace || {}
+          patch_gapi! :hierarchical_namespace
+        end
+
         ##
         # Updates the bucket with changes made in the given block in a single
         # PATCH request. The following attributes may be set: {#cors},
@@ -3131,9 +3187,9 @@ module Google
           attributes.flatten!
           return if attributes.empty?
           ensure_service!
-          patch_args = Hash[attributes.map do |attr|
+          patch_args = attributes.to_h do |attr|
             [attr, @gapi.send(attr)]
-          end]
+          end
           patch_gapi = API::Bucket.new(**patch_args)
           @gapi = service.patch_bucket name,
                                        patch_gapi,
@@ -3151,9 +3207,9 @@ module Google
           attributes.flatten!
           return if attributes.empty?
           ensure_service!
-          update_args = Hash[attributes.map do |attr|
+          update_args = attributes.to_h do |attr|
             [attr, @gapi.send(attr)]
-          end]
+          end
           update_gapi = API::Bucket.new(**update_args)
           @gapi = service.update_bucket name,
                                         update_gapi,

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

@@ -92,7 +92,7 @@ module Google
 
           def error_msg attr_name
             "Service account credentials '#{attr_name}' is missing. To generate service account credentials " \
-            "see https://cloud.google.com/iam/docs/service-accounts"
+              "see https://cloud.google.com/iam/docs/service-accounts"
           end
 
           def post_object options
@@ -145,8 +145,8 @@ module Google
 
           def generate_signed_url issuer, signed_string, expires, query
             url = "#{ext_url}?GoogleAccessId=#{url_escape issuer}" \
-              "&Expires=#{expires}" \
-              "&Signature=#{url_escape signed_string}"
+                  "&Expires=#{expires}" \
+                  "&Signature=#{url_escape signed_string}"
 
             query&.each do |name, value|
               url << "&#{url_escape name}=#{url_escape value}"

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

@@ -131,7 +131,7 @@ module Google
           # methods below are public visibility only for unit testing
           # rubocop:disable Style/StringLiterals
           def escape_characters str
-            str.split("").map do |s|
+            str.chars.map do |s|
               if s.ascii_only?
                 case s
                 when "\\"
@@ -207,7 +207,7 @@ module Google
 
           def error_msg attr_name
             "Service account credentials '#{attr_name}' is missing. To generate service account credentials " \
-            "see https://cloud.google.com/iam/docs/service-accounts"
+              "see https://cloud.google.com/iam/docs/service-accounts"
           end
 
           def service_account_signer signer
@@ -243,7 +243,7 @@ module Google
             headers_arr = canonical_headers.map do |k, v|
               [k.downcase, v.strip.gsub(/[^\S\t]+/, " ").gsub(/\t+/, " ")]
             end
-            canonical_headers = Hash[headers_arr]
+            canonical_headers = headers_arr.to_h
             canonical_headers["host"] = host_name virtual_hosted_style, bucket_bound_hostname
 
             canonical_headers = canonical_headers.sort_by(&:first).to_h
@@ -295,7 +295,7 @@ module Google
           ##
           # The external path to the bucket, with trailing slash.
           def bucket_path path_style
-            return "/#{@bucket_name}/" if path_style
+            "/#{@bucket_name}/" if path_style
           end
 
           ##

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

@@ -2072,15 +2072,59 @@ module Google
         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]
+          attr_params = attributes.to_h 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
 
+        ##
+        # from_gs_url is a method to fetch bucket details and file details from a gs url
+        #
+        # @return [Hash(String => String)]
+        #
+        # @example Fetch bucket_name and file_Path from gs url:
+        #   require "google/cloud/storage"
+        #   gs_url= "gs://my-todo-app/avatars/heidi.jpeg"
+        #   file=Google::Cloud::Storage::File
+        #   file.from_gs_url(gs_url)
+        #   =>
+        #   {"bucket_name"=>"my-todo-app", "file_path"=>"avatars/heidi.jpeg"}
+        #
+        # @example Fetch bucket_name , file_Path and other query params from gs url:
+        #   require "google/cloud/storage"
+        #   gs_url= "gs://my-todo-app/test_sub_folder/heidi.jpeg?params1=test1&params2=test2"
+        #   file=Google::Cloud::Storage::File
+        #   file.from_gs_url(gs_url)
+        #   =>{
+        #     "bucket_name"=>"my-todo-app",
+        #     "file_path"=>"test_sub_folder/heidi.jpeg",
+        #     "options" => {
+        #       "params1"=>"test1",
+        #       "params2"=>"test2"
+        #       }
+        #      }
+
+        def self.from_gs_url gs_url
+          prefix = "gs://".freeze
+          raise ArgumentError, "Invalid GCS URL" unless gs_url.start_with? prefix
+          # seprating params from input url
+          path, query = gs_url.sub(prefix, "").split("?", 2)
+          # parsing the url
+          bucket_name, file_path = path.split "/", 2
+          query_params = URI.decode_www_form(query).to_h if query
+          url_items = {
+            "bucket_name" => bucket_name,
+            "file_path" => file_path
+          }
+          # adding url params to output hash
+          url_items.merge! "options" => query_params if query
+          url_items
+        end
+
         protected
 
         ##
@@ -2196,10 +2240,8 @@ module Google
           [dest_bucket, dest_path]
         end
 
-        # rubocop:disable Style/MultipleComparison
-
         def verify_file! file, verify = :md5
-          verify_md5    = verify == :md5    || verify == :all
+          verify_md5    = verify == :md5 || verify == :all
           verify_crc32c = verify == :crc32c || verify == :all
           Verifier.verify_md5! self, file    if verify_md5    && md5
           Verifier.verify_crc32c! self, file if verify_crc32c && crc32c

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

@@ -421,6 +421,7 @@ module Google
         #     b.lifecycle.add_set_storage_class_rule "COLDLINE", age: 10
         #   end
         #
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def create_bucket bucket_name,
                           acl: nil,
                           default_acl: nil,
@@ -435,11 +436,13 @@ module Google
                           requester_pays: nil,
                           user_project: nil,
                           autoclass_enabled: false,
-                          enable_object_retention: nil
+                          enable_object_retention: nil,
+                          hierarchical_namespace: nil
           params = {
             name: bucket_name,
             location: location,
-            custom_placement_config: custom_placement_config
+            custom_placement_config: custom_placement_config,
+            hierarchical_namespace: hierarchical_namespace
           }.delete_if { |_, v| v.nil? }
           new_bucket = Google::Apis::StorageV1::Bucket.new(**params)
           storage_class = storage_class_for storage_class
@@ -452,6 +455,7 @@ module Google
             b.website_404 = website_404 unless website_404.nil?
             b.versioning = versioning unless versioning.nil?
             b.requester_pays = requester_pays unless requester_pays.nil?
+            b.hierarchical_namespace = hierarchical_namespace unless hierarchical_namespace.nil?
           end
           yield updater if block_given?
           updater.check_for_changed_labels!
@@ -463,6 +467,7 @@ module Google
                         enable_object_retention: enable_object_retention
           Bucket.from_gapi gapi, service, user_project: user_project
         end
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         ##
         # Creates a new HMAC key.

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

@@ -543,7 +543,6 @@ module Google
                          if_metageneration_match: nil,
                          user_project: nil,
                          options: {}
-
           source_objects = compose_file_source_objects source_files, if_source_generation_match
           compose_req = Google::Apis::StorageV1::ComposeRequest.new source_objects: source_objects,
                                                                     destination: destination_gapi
@@ -638,7 +637,6 @@ module Google
                         if_metageneration_not_match: nil,
                         user_project: nil,
                         options: {}
-
           if options[:retries].nil?
             is_idempotent = retry? generation: generation, if_generation_match: if_generation_match
             options = is_idempotent ? {} : { retries: 0 }
@@ -670,7 +668,6 @@ module Google
                          user_project: nil,
                          fields: nil,
                          options: {}
-
           if options[:retries].nil?
             is_idempotent = retry? generation: generation, if_generation_match: if_generation_match
             options = is_idempotent ? {} : { retries: 0 }
@@ -738,7 +735,6 @@ module Google
         # Returns Google::Apis::StorageV1::HmacKey.
         def create_hmac_key service_account_email, project_id: nil,
                             user_project: nil, options: {}
-
           if options[:retries].nil?
             options = options.merge({ retries: 0 })
           end

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

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

data/lib/google/cloud/storage.rb

@@ -98,11 +98,11 @@ module Google
         scope             ||= configure.scope
         retries           ||= configure.retries
         timeout           ||= configure.timeout
-        open_timeout      ||= (configure.open_timeout || timeout)
-        read_timeout      ||= (configure.read_timeout || timeout)
-        send_timeout      ||= (configure.send_timeout || timeout)
+        open_timeout      ||= configure.open_timeout || timeout
+        read_timeout      ||= configure.read_timeout || timeout
+        send_timeout      ||= configure.send_timeout || timeout
         endpoint          ||= configure.endpoint
-        credentials       ||= (keyfile || default_credentials(scope: scope))
+        credentials       ||= keyfile || default_credentials(scope: scope)
         max_elapsed_time  ||= configure.max_elapsed_time
         base_interval     ||= configure.base_interval
         max_interval      ||= configure.max_interval

data/lib/google-cloud-storage.rb

@@ -79,11 +79,11 @@ module Google
     def storage scope: nil, retries: nil, timeout: nil, open_timeout: nil, read_timeout: nil, send_timeout: nil,
                 max_elapsed_time: nil, base_interval: nil, max_interval: nil, multiplier: nil, upload_chunk_size: nil
       Google::Cloud.storage @project, @keyfile, scope: scope,
-                                                retries: (retries || @retries),
-                                                timeout: (timeout || @timeout),
-                                                open_timeout: (open_timeout || timeout),
-                                                read_timeout: (read_timeout || timeout),
-                                                send_timeout: (send_timeout || timeout),
+                                                retries: retries || @retries,
+                                                timeout: timeout || @timeout,
+                                                open_timeout: open_timeout || timeout,
+                                                read_timeout: read_timeout || timeout,
+                                                send_timeout: send_timeout || timeout,
                                                 max_elapsed_time: max_elapsed_time,
                                                 base_interval: base_interval,
                                                 max_interval: max_interval,
@@ -149,9 +149,9 @@ module Google
                                  scope: scope,
                                  retries: retries,
                                  timeout: timeout,
-                                 open_timeout: (open_timeout || timeout),
-                                 read_timeout: (read_timeout || timeout),
-                                 send_timeout: (send_timeout || timeout),
+                                 open_timeout: open_timeout || timeout,
+                                 read_timeout: read_timeout || timeout,
+                                 send_timeout: send_timeout || timeout,
                                  max_elapsed_time: max_elapsed_time,
                                  base_interval: base_interval,
                                  max_interval: max_interval,
@@ -162,7 +162,6 @@ module Google
 end
 
 # Set the default storage configuration
-# rubocop:disable Metrics/BlockLength
 Google::Cloud.configure.add_config! :storage do |config|
   default_project = Google::Cloud::Config.deferred do
     ENV["STORAGE_PROJECT"]
@@ -195,4 +194,3 @@ Google::Cloud.configure.add_config! :storage do |config|
   config.add_field! :endpoint, nil, match: String, allow_nil: true
   config.add_field! :universe_domain, nil, match: String, allow_nil: true
 end
-# rubocop:enable Metrics/BlockLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.51.0
+  version: 1.54.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.37'
+        version: '0.38'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.37'
+        version: '0.38'
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.30.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.30.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -333,14 +333,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage