google-cloud-storage 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aedabfdd29823eedcac9c139bd352c3361ba5d0d
-  data.tar.gz: be5105b8c9183e3294a6bb7116f45007747c49a2
+  metadata.gz: ef777ddfd6e259d9f116f3a5996d058d852b7d49
+  data.tar.gz: 9e197669439fe3b3dc9a7bc2a6cbdb6ce9a76bc0
 SHA512:
-  metadata.gz: 5b5160e32c88c4a8b4c20c04cd08ebd3081c94807f2489f1d45852519d12da64d596b38aa7d90a736f409a5f5193e8044b0941f0fa092733cb519cd65418f4d0
-  data.tar.gz: ad3994f964a5f67b324cd6c475b5d59eae0ccec407a6c37018be2f3198985b9031d3faf3746f67865c9c946bd055e5043a5420af8507fb4401b3801632f59b31
+  metadata.gz: 44a7f28a56c19e8b9014891eca1a559e8481b25ea2a0f0ed2ea244793f883395f26ddaf1cdc9d996469ed991f478d969d11151bdd2543e09f2b51d667248c400
+  data.tar.gz: e8db734cf23c2a8fc846baaee9779b9212abd3f5150eeb2e9d5d4ef3094c5803e0d608624d1e228542e6bf61cb0f53cf158b68bed267c80ca4dc5b2124dc226f

data/lib/google/cloud/storage.rb

@@ -435,6 +435,59 @@ module Google
     # file.acl.public!
     # ```
     #
+    # ## Assigning payment to the requester
+    #
+    # The requester pays feature enables the owner of a bucket to indicate that
+    # a client accessing the bucket or a file it contains must assume the
+    # transit costs related to the access. This feature is currently available
+    # only to whitelisted projects.
+    #
+    # Assign transit costs for bucket and file operations to requesting clients
+    # with the `requester_pays` flag:
+    #
+    # ```ruby
+    # require "google/cloud/storage"
+    #
+    # storage = Google::Cloud::Storage.new
+    #
+    # bucket = storage.bucket "my-bucket"
+    #
+    # bucket.requester_pays = true # API call
+    # # Clients must now provide `user_project` option when calling
+    # # Project#bucket to access this bucket.
+    # ```
+    #
+    # Once the `requester_pays` flag is enabled for a bucket, a client
+    # attempting to access the bucket and its files must provide the
+    # `user_project` option to {Project#bucket}. If the argument given is
+    # `true`, transit costs for operations on the requested bucket or a file it
+    # contains will be billed to the current project for the client. (See
+    # {Project#project} for the ID of the current project.)
+    #
+    # ```ruby
+    # require "google/cloud/storage"
+    #
+    # storage = Google::Cloud::Storage.new
+    #
+    # bucket = storage.bucket "other-project-bucket", user_project: true
+    #
+    # files = bucket.files # Billed to current project
+    # ```
+    #
+    # If the argument is a project ID string, and the indicated project is
+    # authorized for the currently authenticated service account, transit costs
+    # will be billed to the indicated project.
+    #
+    # ```ruby
+    # require "google/cloud/storage"
+    #
+    # storage = Google::Cloud::Storage.new
+    #
+    # bucket = storage.bucket "other-project-bucket",
+    #                         user_project: "my-other-project"
+    # files = bucket.files # Billed to "my-other-project"
+    # ```
+    #
     # ## Configuring retries and timeout
     #
     # You can configure how many times API requests may be automatically

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

@@ -46,11 +46,43 @@ module Google
         # @private The Google API Client object.
         attr_accessor :gapi
 
+        ##
+        # A boolean value or a project ID string for a requester pays
+        # bucket and its files. If this attribute is set to `true`, transit
+        # costs for operations on the bucket will be billed to the current
+        # project for this client. (See {Project#project} for the ID of the
+        # current project.) If this attribute is set to a project ID, and that
+        # project is authorized for the currently authenticated service account,
+        # transit costs will be billed to the that project. The default is
+        # `nil`.
+        #
+        # In general, this attribute should be set when first retrieving the
+        # bucket by providing the `user_project` option to {Project#bucket}.
+        #
+        # The requester pays feature is currently available only to whitelisted
+        # projects.
+        #
+        # See also {#requester_pays=} and {#requester_pays} to enable requester
+        # pays for a bucket.
+        #
+        # @example Setting a non-default project:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "other-project-bucket", user_project: true
+        #   files = bucket.files # Billed to current project
+        #   bucket.user_project = "my-other-project"
+        #   files = bucket.files # Billed to "my-other-project"
+        #
+        attr_accessor :user_project
+
         ##
         # @private Create an empty Bucket object.
         def initialize
           @service = nil
           @gapi = Google::Apis::StorageV1::Bucket.new
+          @user_project = nil
         end
 
         ##
@@ -293,13 +325,60 @@ module Google
           patch_gapi! :website
         end
 
+        ##
+        # Indicates that a client accessing the bucket or a file it contains
+        # must assume the transit costs related to the access. The requester
+        # must pass the `user_project` option to {Project#bucket} to indicate
+        # the project to which the access costs should be billed.
+        #
+        # This feature is currently available only to whitelisted projects.
+        #
+        # @return [Boolean, nil] Returns `true` if requester pays is enabled for
+        #   the bucket.
+        #
+        def requester_pays
+          @gapi.billing.requester_pays if @gapi.billing
+        end
+        alias_method :requester_pays?, :requester_pays
+
+        ##
+        # Enables requester pays for the bucket. If enabled, a client accessing
+        # the bucket or a file it contains must assume the transit costs related
+        # to the access. The requester must pass the `user_project` option to
+        # {Project#bucket} to indicate the project to which the access costs
+        # should be billed.
+        #
+        # This feature is currently available only to whitelisted projects.
+        #
+        # @param [Boolean] new_requester_pays When set to `true`, requester pays
+        #   is enabled for the bucket.
+        #
+        # @example Enable requester pays for a bucket:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   bucket.requester_pays = true # API call
+        #   # Other projects must now provide `user_project` option when calling
+        #   # Project#bucket to access this bucket.
+        #
+        def requester_pays= new_requester_pays
+          @gapi.billing ||= Google::Apis::StorageV1::Bucket::Billing.new
+          @gapi.billing.requester_pays = new_requester_pays
+          patch_gapi! :billing
+        end
+
         ##
         # Updates the bucket with changes made in the given block in a single
         # PATCH request. The following attributes may be set: {#cors},
         # {#logging_bucket=}, {#logging_prefix=}, {#versioning=},
-        # {#website_main=}, and {#website_404=}. In addition, the #cors
-        # configuration accessible in the block is completely mutable and will
-        # be included in the request. (See {Bucket::Cors})
+        # {#website_main=}, {#website_404=}, and {#requester_pays=}.
+        #
+        # In addition, the #cors configuration accessible in the block is
+        # completely mutable and will be included in the request. (See
+        # {Bucket::Cors})
         #
         # @yield [bucket] a block yielding a delegate object for updating the
         #   file
@@ -360,7 +439,7 @@ module Google
         #
         def delete
           ensure_service!
-          service.delete_bucket name
+          service.delete_bucket name, user_project: user_project
           true
         end
 
@@ -414,16 +493,12 @@ module Google
         def files prefix: nil, delimiter: nil, token: nil, max: nil,
                   versions: nil
           ensure_service!
-          options = {
-            prefix:    prefix,
-            delimiter: delimiter,
-            token:     token,
-            max:       max,
-            versions:  versions
-          }
-          gapi = service.list_files name, options
+          gapi = service.list_files name, prefix: prefix, delimiter: delimiter,
+                                          token: token, max: max,
+                                          versions: versions,
+                                          user_project: user_project
           File::List.from_gapi gapi, service, name, prefix, delimiter, max,
-                               versions
+                               versions, user_project: user_project
         end
         alias_method :find_files, :files
 
@@ -458,9 +533,10 @@ module Google
         #
         def file path, generation: nil, encryption_key: nil
           ensure_service!
-          options = { generation: generation, key: encryption_key }
-          gapi = service.get_file name, path, options
-          File.from_gapi gapi, service
+          gapi = service.get_file name, path, generation: generation,
+                                              key: encryption_key,
+                                              user_project: user_project
+          File.from_gapi gapi, service, user_project: user_project
         rescue Google::Cloud::NotFoundError
           nil
         end
@@ -542,7 +618,7 @@ module Google
         #   cost of storage. Values include `:multi_regional`, `:regional`,
         #   `:nearline`, `:coldline`, `:standard`, and `:dra` (Durable Reduced
         #   Availability), as well as the strings returned by
-        #   {Bucket#storage_class}. For more information, see [Storage
+        #   {#storage_class}. For more information, see [Storage
         #   Classes](https://cloud.google.com/storage/docs/storage-classes) and
         #   [Per-Object Storage
         #   Class](https://cloud.google.com/storage/docs/per-object-storage-class).
@@ -601,7 +677,8 @@ module Google
                       content_disposition: content_disposition, crc32c: crc32c,
                       content_encoding: content_encoding, metadata: metadata,
                       content_language: content_language, key: encryption_key,
-                      storage_class: storage_class_for(storage_class) }
+                      storage_class: storage_class_for(storage_class),
+                      user_project: user_project }
           ensure_io_or_file_exists! file
           path ||= file.path if file.respond_to? :path
           path ||= file if file.is_a? String
@@ -811,12 +888,11 @@ module Google
                         client_email: nil, signing_key: nil,
                         private_key: nil
           ensure_service!
-          options = { issuer: issuer, client_email: client_email,
-                      signing_key: signing_key, private_key: private_key,
-                      policy: policy }
 
           signer = File::Signer.from_bucket self, path
-          signer.post_object options
+          signer.post_object issuer: issuer, client_email: client_email,
+                             signing_key: signing_key, private_key: private_key,
+                             policy: policy
         end
 
         ##
@@ -950,7 +1026,7 @@ module Google
         def policy force: nil
           warn "DEPRECATED: 'force' in Bucket#policy" unless force.nil?
           ensure_service!
-          gapi = service.get_bucket_policy name
+          gapi = service.get_bucket_policy name, user_project: user_project
           policy = Policy.from_gapi gapi
           return policy unless block_given?
           yield policy
@@ -991,7 +1067,8 @@ module Google
         #
         def policy= new_policy
           ensure_service!
-          gapi = service.set_bucket_policy name, new_policy.to_gapi
+          gapi = service.set_bucket_policy name, new_policy.to_gapi,
+                                           user_project: user_project
           Policy.from_gapi gapi
         end
 
@@ -1024,7 +1101,8 @@ module Google
         def test_permissions *permissions
           permissions = Array(permissions).flatten
           ensure_service!
-          gapi = service.test_bucket_permissions name, permissions
+          gapi = service.test_bucket_permissions name, permissions,
+                                                 user_project: user_project
           gapi.permissions
         end
 
@@ -1038,10 +1116,11 @@ module Google
 
         ##
         # @private New Bucket from a Google API Client object.
-        def self.from_gapi gapi, conn
+        def self.from_gapi gapi, service, user_project: nil
           new.tap do |f|
             f.gapi = gapi
-            f.service = conn
+            f.service = service
+            f.user_project = user_project
           end
         end
 
@@ -1061,7 +1140,8 @@ module Google
             [attr, @gapi.send(attr)]
           end]
           patch_gapi = Google::Apis::StorageV1::Bucket.new patch_args
-          @gapi = service.patch_bucket name, patch_gapi
+          @gapi = service.patch_bucket name, patch_gapi,
+                                       user_project: user_project
         end
 
         ##

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

@@ -48,12 +48,35 @@ module Google
                     "publicReadWrite" => "publicReadWrite",
                     "public_write" => "publicReadWrite" }
 
+          ##
+          # A boolean value or a project ID string for a requester pays
+          # bucket and its files. If this attribute is set to `true`, transit
+          # costs for operations on the bucket will be billed to the current
+          # project for this client. (See {Project#project} for the ID of the
+          # current project.) If this attribute is set to a project ID, and that
+          # project is authorized for the currently authenticated service
+          # account, transit costs will be billed to the that project. The
+          # default is `nil`.
+          #
+          # In general, this attribute should be set when first retrieving the
+          # owning bucket by providing the `user_project` option to
+          # {Project#bucket}.
+          #
+          # The requester pays feature is currently available only to
+          # whitelisted projects.
+          #
+          # See also {Bucket#requester_pays=} and {Bucket#requester_pays} to
+          # enable requester pays for a bucket.
+          #
+          attr_accessor :user_project
+
           ##
           # @private Initialized a new Acl object.
           # Must provide a valid Bucket object.
           def initialize bucket
             @bucket = bucket.name
             @service = bucket.service
+            @user_project = bucket.user_project
             @owners  = nil
             @writers = nil
             @readers = nil
@@ -72,7 +95,7 @@ module Google
           #   bucket.acl.reload!
           #
           def reload!
-            gapi = @service.list_bucket_acls @bucket
+            gapi = @service.list_bucket_acls @bucket, user_project: user_project
             acls = Array(gapi.items)
             @owners  = entities_from_acls acls, "OWNER"
             @writers = entities_from_acls acls, "WRITER"
@@ -215,7 +238,8 @@ module Google
           #   bucket.acl.add_writer "group-#{email}"
           #
           def add_writer entity
-            gapi = @service.insert_bucket_acl @bucket, entity, "WRITER"
+            gapi = @service.insert_bucket_acl @bucket, entity, "WRITER",
+                                              user_project: user_project
             entity = gapi.entity
             @writers.push entity unless @writers.nil?
             entity
@@ -290,7 +314,8 @@ module Google
           #   bucket.acl.delete "user-#{email}"
           #
           def delete entity
-            @service.delete_bucket_acl @bucket, entity
+            @service.delete_bucket_acl @bucket, entity,
+                                       user_project: user_project
             @owners.delete entity  unless @owners.nil?
             @writers.delete entity unless @writers.nil?
             @readers.delete entity unless @readers.nil?
@@ -406,7 +431,8 @@ module Google
           end
 
           def update_predefined_acl! acl_role
-            @service.patch_bucket @bucket, predefined_acl: acl_role
+            @service.patch_bucket @bucket, predefined_acl: acl_role,
+                                           user_project: user_project
             clear!
           end
 
@@ -449,12 +475,35 @@ module Google
                     "public" => "publicRead",
                     "public_read" => "publicRead" }
 
+          ##
+          # A boolean value or a project ID string for a requester pays
+          # bucket and its files. If this attribute is set to `true`, transit
+          # costs for operations on the bucket will be billed to the current
+          # project for this client. (See {Project#project} for the ID of the
+          # current project.) If this attribute is set to a project ID, and that
+          # project is authorized for the currently authenticated service
+          # account, transit costs will be billed to the that project. The
+          # default is `nil`.
+          #
+          # In general, this attribute should be set when first retrieving the
+          # owning bucket by providing the `user_project` option to
+          # {Project#bucket}.
+          #
+          # The requester pays feature is currently available only to
+          # whitelisted projects.
+          #
+          # See also {Bucket#requester_pays=} and {Bucket#requester_pays} to
+          # enable requester pays for a bucket.
+          #
+          attr_accessor :user_project
+
           ##
           # @private Initialized a new DefaultAcl object.
           # Must provide a valid Bucket object.
           def initialize bucket
             @bucket = bucket.name
             @service = bucket.service
+            @user_project = bucket.user_project
             @owners  = nil
             @readers = nil
           end
@@ -472,7 +521,8 @@ module Google
           #   bucket.default_acl.reload!
           #
           def reload!
-            gapi = @service.list_default_acls @bucket
+            gapi = @service.list_default_acls @bucket,
+                                              user_project: user_project
             acls = Array(gapi.items).map do |acl|
               next acl if acl.is_a? Google::Apis::StorageV1::ObjectAccessControl
               fail "Unknown ACL format: #{acl.class}" unless acl.is_a? Hash
@@ -557,7 +607,8 @@ module Google
           #   bucket.default_acl.add_owner "group-#{email}"
           #
           def add_owner entity
-            gapi = @service.insert_default_acl @bucket, entity, "OWNER"
+            gapi = @service.insert_default_acl @bucket, entity, "OWNER",
+                                               user_project: user_project
             entity = gapi.entity
             @owners.push entity unless @owners.nil?
             entity
@@ -599,7 +650,8 @@ module Google
           #   bucket.default_acl.add_reader "group-#{email}"
           #
           def add_reader entity
-            gapi = @service.insert_default_acl @bucket, entity, "READER"
+            gapi = @service.insert_default_acl @bucket, entity, "READER",
+                                               user_project: user_project
             entity = gapi.entity
             @readers.push entity unless @readers.nil?
             entity
@@ -632,7 +684,8 @@ module Google
           #   bucket.default_acl.delete "user-#{email}"
           #
           def delete entity
-            @service.delete_default_acl @bucket, entity
+            @service.delete_default_acl @bucket, entity,
+                                        user_project: user_project
             @owners.delete entity  unless @owners.nil?
             @readers.delete entity unless @readers.nil?
             true
@@ -765,7 +818,8 @@ module Google
           end
 
           def update_predefined_default_acl! acl_role
-            @service.patch_bucket @bucket, predefined_default_acl: acl_role
+            @service.patch_bucket @bucket, predefined_default_acl: acl_role,
+                                           user_project: user_project
             clear!
           end
 

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

@@ -71,8 +71,8 @@ module Google
           def next
             return nil unless next?
             ensure_service!
-            options = { prefix: @prefix, token: @token, max: @max }
-            gapi = @service.list_buckets options
+            gapi = @service.list_buckets prefix: @prefix, token: @token,
+                                         max: @max
             Bucket::List.from_gapi gapi, @service, @prefix, @max
           end
 

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

@@ -54,6 +54,38 @@ module Google
         # @private The Connection object.
         attr_accessor :service
 
+        ##
+        # A boolean value or a project ID string for a requester pays
+        # bucket and its files. If this attribute is set to `true`, transit
+        # costs for operations on the file will be billed to the current
+        # project for this client. (See {Project#project} for the ID of the
+        # current project.) If this attribute is set to a project ID, and that
+        # project is authorized for the currently authenticated service account,
+        # transit costs will be billed to the that project. The default is
+        # `nil`.
+        #
+        # In general, this attribute should be set when first retrieving the
+        # owning bucket by providing the `user_project` option to
+        # {Project#bucket}.
+        #
+        # The requester pays feature is currently available only to whitelisted
+        # projects.
+        #
+        # See also {Bucket#requester_pays=} and {Bucket#requester_pays} to
+        # enable requester pays for a bucket.
+        #
+        # @example Setting a non-default project:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "other-project-bucket", user_project: true
+        #   file = bucket.file "path/to/file.ext" # Billed to current project
+        #   file.user_project = "my-other-project"
+        #   file.download "file.ext" # Billed to "my-other-project"
+        #
+        attr_accessor :user_project
+
         ##
         # @private The Google API Client object.
         attr_accessor :gapi
@@ -63,6 +95,7 @@ module Google
         def initialize
           @service = nil
           @gapi = Google::Apis::StorageV1::Object.new
+          @user_project = nil
         end
 
         ##
@@ -425,8 +458,7 @@ module Google
             path.set_encoding "ASCII-8BIT"
           end
           file = service.download_file \
-            bucket, name, path,
-            key: encryption_key
+            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
@@ -520,7 +552,8 @@ module Google
         def copy dest_bucket_or_path, dest_path = nil, acl: nil,
                  generation: nil, encryption_key: nil
           ensure_service!
-          options = { acl: acl, generation: generation, key: encryption_key }
+          options = { acl: acl, generation: generation, key: encryption_key,
+                      user_project: user_project }
           dest_bucket, dest_path, options = fix_copy_args dest_bucket_or_path,
                                                           dest_path, options
 
@@ -591,7 +624,8 @@ module Google
         def rotate encryption_key: nil, new_encryption_key: nil
           ensure_service!
           options = { source_key: encryption_key,
-                      destination_key: new_encryption_key }
+                      destination_key: new_encryption_key,
+                      user_project: user_project }
           gapi = service.rewrite_file bucket, name, bucket, name, nil, options
           until gapi.done
             sleep 1
@@ -618,7 +652,7 @@ module Google
         #
         def delete
           ensure_service!
-          service.delete_file bucket, name
+          service.delete_file bucket, name, user_project: user_project
           true
         end
 
@@ -746,12 +780,12 @@ module Google
                        content_md5: nil, headers: nil, issuer: nil,
                        client_email: nil, signing_key: nil, private_key: nil
           ensure_service!
-          options = { method: method, expires: expires, headers: headers,
-                      content_type: content_type, content_md5: content_md5,
-                      issuer: issuer, client_email: client_email,
-                      signing_key: signing_key, private_key: private_key }
           signer = File::Signer.from_file self
-          signer.signed_url options
+          signer.signed_url method: method, expires: expires, headers: headers,
+                            content_type: content_type,
+                            content_md5: content_md5,
+                            issuer: issuer, client_email: client_email,
+                            signing_key: signing_key, private_key: private_key
         end
 
         ##
@@ -804,7 +838,7 @@ module Google
         # Reloads the file with current data from the Storage service.
         def reload!
           ensure_service!
-          @gapi = service.get_file bucket, name
+          @gapi = service.get_file bucket, name, user_project: user_project
         end
         alias_method :refresh!, :reload!
 
@@ -817,10 +851,11 @@ module Google
 
         ##
         # @private New File from a Google API Client object.
-        def self.from_gapi gapi, service
+        def self.from_gapi gapi, service, user_project: nil
           new.tap do |f|
             f.gapi = gapi
             f.service = service
+            f.user_project = user_project
           end
         end
 
@@ -843,7 +878,8 @@ module Google
           if attributes.include? :storage_class
             @gapi = rewrite_gapi bucket, name, update_gapi
           else
-            @gapi = service.patch_file bucket, name, update_gapi
+            @gapi = service.patch_file \
+              bucket, name, update_gapi, user_project: user_project
           end
         end
 
@@ -857,12 +893,13 @@ module Google
         end
 
         def rewrite_gapi bucket, name, update_gapi
-          resp = service.rewrite_file bucket, name, bucket, name, update_gapi
+          resp = service.rewrite_file \
+            bucket, name, bucket, name, update_gapi, user_project: user_project
           until resp.done
             sleep 1
-            rewrite_options = { token: resp.rewrite_token }
-            resp = service.rewrite_file bucket, name, bucket, name,
-                                        update_gapi, rewrite_options
+            resp = service.rewrite_file \
+              bucket, name, bucket, name, update_gapi,
+              token: resp.rewrite_token, user_project: user_project
           end
           resp.resource
         end

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

@@ -50,6 +50,28 @@ module Google
                     "public" => "publicRead",
                     "public_read" => "publicRead" }
 
+          ##
+          # A boolean value or a project ID string for a requester pays
+          # bucket and its files. If this attribute is set to `true`, transit
+          # costs for operations on the file will be billed to the current
+          # project for this client. (See {Project#project} for the ID of the
+          # current project.) If this attribute is set to a project ID, and that
+          # project is authorized for the currently authenticated service
+          # account, transit costs will be billed to the that project. The
+          # default is `nil`.
+          #
+          # In general, this attribute should be set when first retrieving the
+          # owning bucket by providing the `user_project` option to
+          # {Project#bucket}.
+          #
+          # The requester pays feature is currently available only to
+          # whitelisted projects.
+          #
+          # See also {Bucket#requester_pays=} and {Bucket#requester_pays} to
+          # enable requester pays for a bucket.
+          #
+          attr_accessor :user_project
+
           ##
           # @private Initialized a new Acl object.
           # Must provide a valid Bucket object.
@@ -57,6 +79,7 @@ module Google
             @bucket = file.bucket
             @file = file.name
             @service = file.service
+            @user_project = file.user_project
             @owners  = nil
             @readers = nil
           end
@@ -75,7 +98,8 @@ module Google
           #   file.acl.reload!
           #
           def reload!
-            gapi = @service.list_file_acls @bucket, @file
+            gapi = @service.list_file_acls @bucket, @file,
+                                           user_project: user_project
             acls = Array(gapi.items)
             @owners  = entities_from_acls acls, "OWNER"
             @readers = entities_from_acls acls, "READER"
@@ -163,9 +187,9 @@ module Google
           #   file.acl.add_owner "group-#{email}"
           #
           def add_owner entity, generation: nil
-            options = { generation: generation }
             gapi = @service.insert_file_acl @bucket, @file, entity, "OWNER",
-                                            options
+                                            generation: generation,
+                                            user_project: user_project
             entity = gapi.entity
             @owners.push entity unless @owners.nil?
             entity
@@ -212,9 +236,9 @@ module Google
           #   file.acl.add_reader "group-#{email}"
           #
           def add_reader entity, generation: nil
-            options = { generation: generation }
             gapi = @service.insert_file_acl @bucket, @file, entity, "READER",
-                                            options
+                                            generation: generation,
+                                            user_project: user_project
             entity = gapi.entity
             @readers.push entity unless @readers.nil?
             entity
@@ -250,8 +274,9 @@ module Google
           #   file.acl.delete "user-#{email}"
           #
           def delete entity, generation: nil
-            options = { generation: generation }
-            @service.delete_file_acl @bucket, @file, entity, options
+            @service.delete_file_acl \
+              @bucket, @file, entity,
+              generation: generation, user_project: user_project
             @owners.delete entity  unless @owners.nil?
             @readers.delete entity unless @readers.nil?
             true
@@ -391,8 +416,9 @@ module Google
 
           def update_predefined_acl! acl_role
             patched_file = Google::Apis::StorageV1::Object.new acl: []
-            @service.patch_file \
-              @bucket, @file, patched_file, predefined_acl: acl_role
+            @service.patch_file @bucket, @file, patched_file,
+                                predefined_acl: acl_role,
+                                user_project: user_project
             clear!
           end
 

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

@@ -79,11 +79,12 @@ module Google
             ensure_service!
             options = {
               prefix: @prefix, delimiter: @delimiter, token: @token, max: @max,
-              versions: @versions
+              versions: @versions, user_project: @user_project
             }
             gapi = @service.list_files @bucket, options
             File::List.from_gapi gapi, @service, @bucket, @prefix,
-                                 @delimiter, @max, @versions
+                                 @delimiter, @max, @versions,
+                                 user_project: @user_project
           end
 
           ##
@@ -159,7 +160,8 @@ module Google
           # @private New File::List from a Google API Client
           # Google::Apis::StorageV1::Objects object.
           def self.from_gapi gapi_list, service, bucket = nil, prefix = nil,
-                             delimiter = nil, max = nil, versions = nil
+                             delimiter = nil, max = nil, versions = nil,
+                             user_project: nil
             files = new(Array(gapi_list.items).map do |gapi_object|
               File.from_gapi gapi_object, service
             end)
@@ -171,6 +173,7 @@ module Google
             files.instance_variable_set :@delimiter, delimiter
             files.instance_variable_set :@max, max
             files.instance_variable_set :@versions, versions
+            files.instance_variable_set :@user_project, user_project
             files
           end
 

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

@@ -128,8 +128,7 @@ module Google
         #   end
         #
         def buckets prefix: nil, token: nil, max: nil
-          options = { prefix: prefix, token: token, max: max }
-          gapi = service.list_buckets options
+          gapi = service.list_buckets prefix: prefix, token: token, max: max
           Bucket::List.from_gapi gapi, service, prefix, max
         end
         alias_method :find_buckets, :buckets
@@ -138,6 +137,20 @@ module Google
         # Retrieves bucket by name.
         #
         # @param [String] bucket_name Name of a bucket.
+        # @param [Boolean, String] user_project If the `requester_pays` flag is
+        #   enabled for the requested bucket, and if this parameter is set to
+        #   `true`, transit costs for operations on the requested bucket or a
+        #   file it contains will be billed to the current project for this
+        #   client. (See {#project} for the ID of the current project.) If this
+        #   parameter is set to a project ID other than the current project, and
+        #   that project is authorized for the currently authenticated service
+        #   account, transit costs will be billed to the given project. The
+        #   default is `nil`.
+        #
+        #   The requester pays feature is currently available only to
+        #   whitelisted projects.
+        #
+        #   See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
         #
         # @return [Google::Cloud::Storage::Bucket, nil] Returns nil if bucket
         #   does not exist
@@ -150,9 +163,26 @@ module Google
         #   bucket = storage.bucket "my-bucket"
         #   puts bucket.name
         #
-        def bucket bucket_name
-          gapi = service.get_bucket bucket_name
-          Bucket.from_gapi gapi, service
+        # @example With `user_project` set to pay for a requester pays bucket:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "other-project-bucket", user_project: true
+        #   files = bucket.files # Billed to current project
+        #
+        # @example With `user_project` set to a project other than the default:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "other-project-bucket",
+        #                           user_project: "my-other-project"
+        #   files = bucket.files # Billed to "my-other-project"
+        #
+        def bucket bucket_name, user_project: nil
+          gapi = service.get_bucket bucket_name, user_project: user_project
+          Bucket.from_gapi gapi, service, user_project: user_project
         rescue Google::Cloud::NotFoundError
           nil
         end
@@ -270,6 +300,7 @@ module Google
         #   bucket = storage.create_bucket "my-bucket" do |b|
         #     b.website_main = "index.html"
         #     b.website_404 = "not_found.html"
+        #     b.requester_pays = true
         #     b.cors.add_rule ["http://example.org", "https://example.org"],
         #                      "*",
         #                      headers: ["X-My-Custom-Header"],
@@ -396,12 +427,12 @@ module Google
                        content_type: nil, content_md5: nil, headers: nil,
                        issuer: nil, client_email: nil, signing_key: nil,
                        private_key: nil
-          options = { method: method, expires: expires, headers: headers,
-                      content_type: content_type, content_md5: content_md5,
-                      issuer: issuer, client_email: client_email,
-                      signing_key: signing_key, private_key: private_key }
           signer = File::Signer.new bucket, path, service
-          signer.signed_url options
+          signer.signed_url method: method, expires: expires, headers: headers,
+                            content_type: content_type,
+                            content_md5: content_md5,
+                            issuer: issuer, client_email: client_email,
+                            signing_key: signing_key, private_key: private_key
         end
 
         protected

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

@@ -74,26 +74,29 @@ module Google
         ##
         # Retrieves bucket by name.
         # Returns Google::Apis::StorageV1::Bucket.
-        def get_bucket bucket_name
-          execute { service.get_bucket bucket_name }
+        def get_bucket bucket_name, user_project: nil
+          execute do
+            service.get_bucket bucket_name,
+                               user_project: user_project(user_project)
+          end
         end
 
         ##
         # Creates a new bucket.
         # Returns Google::Apis::StorageV1::Bucket.
-        def insert_bucket bucket_gapi, options = {}
+        def insert_bucket bucket_gapi, acl: nil, default_acl: nil
           execute do
             service.insert_bucket \
               @project, bucket_gapi,
-              predefined_acl: options[:acl],
-              predefined_default_object_acl: options[:default_acl]
+              predefined_acl: acl,
+              predefined_default_object_acl: default_acl
           end
         end
 
         ##
         # Updates a bucket, including its ACL metadata.
         def patch_bucket bucket_name, bucket_gapi = nil, predefined_acl: nil,
-                         predefined_default_acl: nil
+                         predefined_default_acl: nil, user_project: nil
           bucket_gapi ||= Google::Apis::StorageV1::Bucket.new
           bucket_gapi.acl = [] if predefined_acl
           bucket_gapi.default_object_acl = [] if predefined_default_acl
@@ -102,94 +105,117 @@ module Google
             service.patch_bucket \
               bucket_name, bucket_gapi,
               predefined_acl: predefined_acl,
-              predefined_default_object_acl: predefined_default_acl
+              predefined_default_object_acl: predefined_default_acl,
+              user_project: user_project(user_project)
           end
         end
 
         ##
         # Permanently deletes an empty bucket.
-        def delete_bucket bucket_name
-          execute { service.delete_bucket bucket_name }
+        def delete_bucket bucket_name, user_project: nil
+          execute do
+            service.delete_bucket bucket_name,
+                                  user_project: user_project(user_project)
+          end
         end
 
         ##
         # Retrieves a list of ACLs for the given bucket.
-        def list_bucket_acls bucket_name
-          execute { service.list_bucket_access_controls bucket_name }
+        def list_bucket_acls bucket_name, user_project: nil
+          execute do
+            service.list_bucket_access_controls \
+              bucket_name, user_project: user_project(user_project)
+          end
         end
 
         ##
         # Creates a new bucket ACL.
-        def insert_bucket_acl bucket_name, entity, role
+        def insert_bucket_acl bucket_name, entity, role, user_project: nil
           new_acl = Google::Apis::StorageV1::BucketAccessControl.new({
             entity: entity, role: role }.delete_if { |_k, v| v.nil? })
-          execute { service.insert_bucket_access_control bucket_name, new_acl }
+          execute do
+            service.insert_bucket_access_control \
+              bucket_name, new_acl, user_project: user_project(user_project)
+          end
         end
 
         ##
         # Permanently deletes a bucket ACL.
-        def delete_bucket_acl bucket_name, entity
-          execute { service.delete_bucket_access_control bucket_name, entity }
+        def delete_bucket_acl bucket_name, entity, user_project: nil
+          execute do
+            service.delete_bucket_access_control \
+              bucket_name, entity, user_project: user_project(user_project)
+          end
         end
 
         ##
         # Retrieves a list of default ACLs for the given bucket.
-        def list_default_acls bucket_name
-          execute { service.list_default_object_access_controls bucket_name }
+        def list_default_acls bucket_name, user_project: nil
+          execute do
+            service.list_default_object_access_controls \
+              bucket_name, user_project: user_project(user_project)
+          end
         end
 
         ##
         # Creates a new default ACL.
-        def insert_default_acl bucket_name, entity, role
+        def insert_default_acl bucket_name, entity, role, user_project: nil
           new_acl = Google::Apis::StorageV1::ObjectAccessControl.new({
             entity: entity, role: role }.delete_if { |_k, v| v.nil? })
           execute do
-            service.insert_default_object_access_control bucket_name, new_acl
+            service.insert_default_object_access_control \
+              bucket_name, new_acl, user_project: user_project(user_project)
           end
         end
 
         ##
         # Permanently deletes a default ACL.
-        def delete_default_acl bucket_name, entity
+        def delete_default_acl bucket_name, entity, user_project: nil
           execute do
-            service.delete_default_object_access_control bucket_name, entity
+            service.delete_default_object_access_control \
+              bucket_name, entity, user_project: user_project(user_project)
           end
         end
 
         ##
         # Returns Google::Apis::StorageV1::Policy
-        def get_bucket_policy bucket_name
+        def get_bucket_policy bucket_name, user_project: nil
           # get_bucket_iam_policy(bucket, fields: nil, quota_user: nil,
           #                               user_ip: nil, options: nil)
-          execute { service.get_bucket_iam_policy bucket_name }
+          execute do
+            service.get_bucket_iam_policy \
+              bucket_name, user_project: user_project(user_project)
+          end
         end
 
         ##
         # Returns Google::Apis::StorageV1::Policy
-        def set_bucket_policy bucket_name, new_policy
+        def set_bucket_policy bucket_name, new_policy, user_project: nil
           execute do
-            service.set_bucket_iam_policy bucket_name, new_policy
+            service.set_bucket_iam_policy \
+              bucket_name, new_policy, user_project: user_project(user_project)
           end
         end
 
         ##
         # Returns Google::Apis::StorageV1::TestIamPermissionsResponse
-        def test_bucket_permissions bucket_name, permissions
+        def test_bucket_permissions bucket_name, permissions, user_project: nil
           execute do
-            service.test_bucket_iam_permissions bucket_name, permissions
+            service.test_bucket_iam_permissions \
+              bucket_name, permissions, user_project: user_project(user_project)
           end
         end
 
         ##
         # Retrieves a list of files matching the criteria.
-        def list_files bucket_name, options = {}
+        def list_files bucket_name, delimiter: nil, max: nil, token: nil,
+                       prefix: nil, versions: nil, user_project: nil
           execute do
             service.list_objects \
-              bucket_name, delimiter: options[:delimiter],
-                           max_results: options[:max],
-                           page_token: options[:token],
-                           prefix: options[:prefix],
-                           versions: options[:versions]
+              bucket_name, delimiter: delimiter, max_results: max,
+                           page_token: token, prefix: prefix,
+                           versions: versions,
+                           user_project: user_project(user_project)
           end
         end
 
@@ -199,7 +225,7 @@ module Google
                         cache_control: nil, content_disposition: nil,
                         content_encoding: nil, content_language: nil,
                         content_type: nil, crc32c: nil, md5: nil, metadata: nil,
-                        storage_class: nil, key: nil
+                        storage_class: nil, key: nil, user_project: nil
           file_obj = Google::Apis::StorageV1::Object.new({
             cache_control: cache_control, content_type: content_type,
             content_disposition: content_disposition, md5_hash: md5,
@@ -213,17 +239,20 @@ module Google
               bucket_name, file_obj,
               name: path, predefined_acl: acl, upload_source: source,
               content_encoding: content_encoding, content_type: content_type,
+              user_project: user_project(user_project),
               options: key_options(key)
           end
         end
 
         ##
         # Retrieves an object or its metadata.
-        def get_file bucket_name, file_path, generation: nil, key: nil
+        def get_file bucket_name, file_path, generation: nil, key: nil,
+                     user_project: nil
           execute do
             service.get_object \
               bucket_name, file_path,
               generation: generation,
+              user_project: user_project(user_project),
               options: key_options(key)
           end
         end
@@ -232,17 +261,18 @@ module Google
         # destination bucket/object.
         def copy_file source_bucket_name, source_file_path,
                       destination_bucket_name, destination_file_path,
-                      file_gapi = nil, options = {}
-          key_options = rewrite_key_options options[:key],
-                                            options[:key]
+                      file_gapi = nil, key: nil, acl: nil, generation: nil,
+                      token: nil, user_project: nil
+          key_options = rewrite_key_options key, key
           execute do
             service.rewrite_object \
               source_bucket_name, source_file_path,
               destination_bucket_name, destination_file_path,
               file_gapi,
-              destination_predefined_acl: options[:acl],
-              source_generation: options[:generation],
-              rewrite_token: options[:token],
+              destination_predefined_acl: acl,
+              source_generation: generation,
+              rewrite_token: token,
+              user_project: user_project(user_project),
               options: key_options
           end
         end
@@ -251,17 +281,19 @@ module Google
         # destination bucket/object.
         def rewrite_file source_bucket_name, source_file_path,
                          destination_bucket_name, destination_file_path,
-                         file_gapi = nil, options = {}
-          key_options = rewrite_key_options options[:source_key],
-                                            options[:destination_key]
+                         file_gapi = nil, source_key: nil, destination_key: nil,
+                         acl: nil, generation: nil, token: nil,
+                         user_project: nil
+          key_options = rewrite_key_options source_key, destination_key
           execute do
             service.rewrite_object \
               source_bucket_name, source_file_path,
               destination_bucket_name, destination_file_path,
               file_gapi,
-              destination_predefined_acl: options[:acl],
-              source_generation: options[:generation],
-              rewrite_token: options[:token],
+              destination_predefined_acl: acl,
+              source_generation: generation,
+              rewrite_token: token,
+              user_project: user_project(user_project),
               options: key_options
           end
         end
@@ -269,11 +301,12 @@ module Google
         ##
         # Download contents of a file.
         def download_file bucket_name, file_path, target_path, generation: nil,
-                          key: nil
+                          key: nil, user_project: nil
           execute do
             service.get_object \
               bucket_name, file_path,
               download_dest: target_path, generation: generation,
+              user_project: user_project(user_project),
               options: key_options(key)
           end
         end
@@ -281,44 +314,55 @@ module Google
         ##
         # Updates a file's metadata.
         def patch_file bucket_name, file_path, file_gapi = nil,
-                       predefined_acl: nil
+                       predefined_acl: nil, user_project: nil
           file_gapi ||= Google::Apis::StorageV1::Object.new
           execute do
             service.patch_object \
               bucket_name, file_path, file_gapi,
-              predefined_acl: predefined_acl
+              predefined_acl: predefined_acl,
+              user_project: user_project(user_project)
           end
         end
 
         ##
         # Permanently deletes a file.
-        def delete_file bucket_name, file_path
-          execute { service.delete_object bucket_name, file_path }
+        def delete_file bucket_name, file_path, user_project: nil
+          execute do
+            service.delete_object bucket_name, file_path,
+                                  user_project: user_project(user_project)
+          end
         end
 
         ##
         # Retrieves a list of ACLs for the given file.
-        def list_file_acls bucket_name, file_name
-          execute { service.list_object_access_controls bucket_name, file_name }
+        def list_file_acls bucket_name, file_name, user_project: nil
+          execute do
+            service.list_object_access_controls \
+              bucket_name, file_name, user_project: user_project(user_project)
+          end
         end
 
         ##
         # Creates a new file ACL.
-        def insert_file_acl bucket_name, file_name, entity, role, options = {}
+        def insert_file_acl bucket_name, file_name, entity, role,
+                            generation: nil, user_project: nil
           new_acl = Google::Apis::StorageV1::ObjectAccessControl.new({
             entity: entity, role: role }.delete_if { |_k, v| v.nil? })
           execute do
             service.insert_object_access_control \
-              bucket_name, file_name, new_acl, generation: options[:generation]
+              bucket_name, file_name, new_acl,
+              generation: generation, user_project: user_project(user_project)
           end
         end
 
         ##
         # Permanently deletes a file ACL.
-        def delete_file_acl bucket_name, file_name, entity, options = {}
+        def delete_file_acl bucket_name, file_name, entity, generation: nil,
+                            user_project: nil
           execute do
             service.delete_object_access_control \
-              bucket_name, file_name, entity, generation: options[:generation]
+              bucket_name, file_name, entity,
+              generation: generation, user_project: user_project(user_project)
           end
         end
 
@@ -336,6 +380,12 @@ module Google
 
         protected
 
+        def user_project user_project
+          return nil unless user_project # nil or false get nil
+          return @project if user_project == true # handle the true  condition
+          String(user_project) # convert the value to a string
+        end
+
         def key_options key
           options = {}
           encryption_key_headers options, key if key

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Storage
-      VERSION = "1.1.0"
+      VERSION = "1.2.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: digest-crc
   requirement: !ruby/object:Gem::Requirement