google-cloud-storage 1.57.0 → 1.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ba3f85cab0b6bd616c783973578f6f3610d23bd9679e74a42f77eda3e5b7b20
-  data.tar.gz: c5399ac6a4e32d290f3c112ee435696d176c4afe329213acbca36cc629a1f647
+  metadata.gz: d5702660db1aed635fecb508a9f704e9f42fab5aa79db322097e775fbe0c60eb
+  data.tar.gz: e4ce8ea28ef05a416e3f1f751365f7fef62b2599be2d5b22dcd91d5a735b0cd4
 SHA512:
-  metadata.gz: 3655fcc4fe59d97a956c1dd4ab3d98abdcf406261b2bb4d30a3c300d4c64aa37d2c7262c99484befa1538758ba4240b5e0a51d0ed753066a850db3d82a74b9ea
-  data.tar.gz: 9f0c4e40ecc8f906259d2a2c027b419c464519b65b83309e574f5cd4f7bc9eae55dd5c0735798e96be8b5696af75e315f1ee299dc4e91cba374c6119b3258e78
+  metadata.gz: e981b3eddd57eb932728eeb6f3e19d4442e4d88f190aba854e764d95b901e4756b164142b835088407e3993c7f989ccfd24aac17432f02aff87fe8c3b4ccf921
+  data.tar.gz: dbe8ece884a8bbb25416806c236098e279eadd3b8d3e223a3134de71f76f40fc307a1a54dcedcf45512ae1e0e925eec3adc90ba3831b5a436fd7a531e55c190d

data/AUTHENTICATION.md

@@ -28,6 +28,12 @@ providing **Project ID** and **Service Account Credentials** directly in code.
 
 **Credentials** are discovered in the following order:
 
+> [!WARNING]
+> If you accept a credential configuration (JSON file or Hash) from an
+> external source for authentication to Google Cloud, you must validate it before
+> providing it to a Google API client library. Providing an unvalidated credential
+> configuration to Google APIs can compromise the security of your systems and data.
+
 1. Specify credentials in method arguments
 2. Specify credentials in configuration
 3. Discover credentials path in environment variables
@@ -81,11 +87,17 @@ The **Project ID** and the path to the **Credentials JSON** file can be configur
 instead of placing them in environment variables or providing them as arguments.
 
 ```ruby
+require "googleauth"
 require "google/cloud/storage"
 
+credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+  json_key_io: ::File.open("/path/to/keyfile.json"),
+  scope: "https://www.googleapis.com/auth/devstorage.full_control"
+)
+
 Google::Cloud::Storage.configure do |config|
   config.project_id  = "my-project-id"
-  config.credentials = "path/to/keyfile.json"
+  config.credentials = credentials
 end
 
 storage = Google::Cloud::Storage.new

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 1.58.0 (2026-01-08)
+
+#### Features
+
+* Adding support for partial success bucket list  ([#32173](https://github.com/googleapis/google-cloud-ruby/issues/32173)) 
+
+### 1.57.1 (2025-11-04)
+
+#### Documentation
+
+* add warning about loading unvalidated credentials ([#31776](https://github.com/googleapis/google-cloud-ruby/issues/31776)) 
+
 ### 1.57.0 (2025-08-15)
 
 #### Features

data/OVERVIEW.md

@@ -14,11 +14,17 @@ your code or via environment variables. Read more about the options for
 connecting in the {file:AUTHENTICATION.md Authentication Guide}.
 
 ```ruby
+require "googleauth"
 require "google/cloud/storage"
 
+credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+  json_key_io: ::File.open("/path/to/keyfile.json"),
+  scope: "https://www.googleapis.com/auth/devstorage.full_control"
+)
+
 storage = Google::Cloud::Storage.new(
   project_id: "my-project",
-  credentials: "/path/to/keyfile.json"
+  credentials: credentials
 )
 
 bucket = storage.bucket "my-bucket"

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

@@ -27,6 +27,14 @@ module Google
           # that match the request and this value should be passed to
           # the next {Google::Cloud::Storage::Project#buckets} to continue.
           attr_accessor :token
+          ##
+          # Provides a list of bucket names that are unreachable.
+          #
+          # This is only populated when `return_partial_success` is set to `true`
+          # in the call to {Google::Cloud::Storage::Project#buckets}.
+          #
+          # @return [Array<String>]
+          attr_reader :unreachable
 
           ##
           # @private Create a new Bucket::List with an array of values.
@@ -147,7 +155,7 @@ module Google
           # @private New Bucket::List from a Google API Client
           # Google::Apis::StorageV1::Buckets object.
           def self.from_gapi gapi_list, service, prefix = nil, max = nil,
-                             user_project: nil, soft_deleted: nil
+                             user_project: nil, soft_deleted: nil, return_partial_success: nil
             buckets = new(Array(gapi_list.items).map do |gapi_object|
               Bucket.from_gapi gapi_object, service, user_project: user_project
             end)
@@ -157,6 +165,7 @@ module Google
             buckets.instance_variable_set :@max, max
             buckets.instance_variable_set :@user_project, user_project
             buckets.instance_variable_set :@soft_deleted, soft_deleted
+            buckets.instance_variable_set :@unreachable, Array(gapi_list.unreachable) if return_partial_success
             buckets
           end
 

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

@@ -25,18 +25,29 @@ module Google
       # Storage API.
       #
       # @example
+      #   # The recommended way to provide credentials is to use the `make_creds` method
+      #   # on the appropriate credentials class for your environment.
+      #
+      #   require "googleauth"
       #   require "google/cloud/storage"
       #
-      #   keyfile = "/path/to/keyfile.json"
-      #   creds = Google::Cloud::Storage::Credentials.new keyfile
+      #   credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+      #     json_key_io: ::File.open("/path/to/keyfile.json"),
+      #     scope: "https://www.googleapis.com/auth/devstorage.full_control"
+      #   )
       #
       #   storage = Google::Cloud::Storage.new(
       #     project_id: "my-project",
-      #     credentials: creds
+      #     credentials: credentials
       #   )
       #
       #   storage.project_id #=> "my-project"
       #
+      # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
+      #   external source for authentication to Google Cloud, you must validate it before
+      #   providing it to a Google API client library. Providing an unvalidated credential
+      #   configuration to Google APIs can compromise the security of your systems and data.
+      #
       class Credentials < Google::Auth::Credentials
         SCOPE = ["https://www.googleapis.com/auth/devstorage.full_control"].freeze
         PATH_ENV_VARS = [

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

@@ -158,6 +158,9 @@ module Google
         #   bucket instances and their files.
         #
         #   See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
+        # @param [Boolean] return_partial_success
+        # If true, the response will contain a list of unreachable buckets.
+        # If false, ListBuckets will throw an error if there are any unreachable buckets.
         #
         # @return [Array<Google::Cloud::Storage::Bucket>] (See
         #   {Google::Cloud::Storage::Bucket::List})
@@ -201,11 +204,22 @@ module Google
         #   soft_deleted_buckets.each do |bucket|
         #     puts bucket.name
         #   end
-        def buckets prefix: nil, token: nil, max: nil, user_project: nil, soft_deleted: nil
+        # @example Retrieve list of unreachable buckets
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   buckets = storage.buckets return_partial_success: true
+        #   buckets.unreachable.each do |unreachable_bucket_name|
+        #     puts unreachable_bucket_name
+        #   end
+        #  
+        def buckets prefix: nil, token: nil, max: nil, user_project: nil, soft_deleted: nil, return_partial_success: nil
           gapi = service.list_buckets \
-            prefix: prefix, token: token, max: max, user_project: user_project, soft_deleted: soft_deleted
+            prefix: prefix, token: token, max: max, user_project: user_project, soft_deleted: soft_deleted, return_partial_success: return_partial_success
           Bucket::List.from_gapi \
-            gapi, service, prefix, max, user_project: user_project, soft_deleted: soft_deleted
+            gapi, service, prefix, max, user_project: user_project, soft_deleted: soft_deleted, return_partial_success: return_partial_success
+          
         end
         alias find_buckets buckets
 

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

@@ -96,12 +96,14 @@ module Google
 
         ##
         # Retrieves a list of buckets for the given project.
-        def list_buckets prefix: nil, token: nil, max: nil, user_project: nil, soft_deleted: nil, options: {}
+        def list_buckets prefix: nil, token: nil, max: nil, user_project: nil, soft_deleted: nil, return_partial_success: nil, options: {}
           execute do
             service.list_buckets \
               @project, prefix: prefix, page_token: token, max_results: max,
                         user_project: user_project(user_project),
-                        soft_deleted: soft_deleted, options: options
+                        soft_deleted: soft_deleted,
+                        return_partial_success: return_partial_success,
+                        options: options
           end
         end
 

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

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

data/lib/google/cloud/storage.rb

@@ -42,9 +42,12 @@ module Google
       # @param [String] project_id Project identifier for the Storage service
       #   you are connecting to. If not present, the default project for the
       #   credentials is used.
-      # @param [String, Hash, Google::Auth::Credentials] credentials The path to
-      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-      #   Google::Auth::Credentials object. (See {Storage::Credentials})
+      # @param [Google::Auth::Credentials] credentials A Google::Auth::Credentials
+      #   object. (See {Storage::Credentials})
+      # @note Warning: Passing a `String` to a keyfile path or a `Hash` of
+      #   credentials is deprecated. Providing an unvalidated credential
+      #   configuration to Google APIs can compromise the security of your
+      #   systems and data.
       # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       #   See [Using OAuth 2.0 to Access Google

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.57.0
+  version: 1.58.0
 platform: ruby
 authors:
 - Mike Moore