google-cloud-storage 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b7f1798224baa310d43cdd64174d46389b6c66c
-  data.tar.gz: 5cd8d77373e98f5858c430aa07592ec316bf0ab1
+  metadata.gz: 785ee684ed3d6225bea9ef029a33739162b73482
+  data.tar.gz: 795d5c813467496884077148427406a138086e3d
 SHA512:
-  metadata.gz: 6e8caa5b4112ae3f8d8aad56157f612006eb6bb3944668c9e2f491449cf46d9fe834703863c8e372b237ad800aaa67cc60fbb92bc11662650814693127b08945
-  data.tar.gz: 8b5272dfad3534f26db99f153bae01e2a25c5931eefe7897a4a8344bda30669a3f6525f4d85581d4277c0197a3f35fa3ff096d54e6f922c180c1a77508304d7f
+  metadata.gz: 8d943e560150efb216a55999bcf327277bccf5b12329a6b382147a16a29e1509e4c722c28993bf1cd626b88f51b4cec4d444b141df3881fea2595a7b4e45262c
+  data.tar.gz: 1a74ee5f03dff72f2ab1cdb7568bab73cb6b7d5ece7818f310712b8dff0e67e0e9eccfe2c178c36c1dd51763008b20f59d0f08c757a08ce159c47e26fce8717b

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

@@ -342,8 +342,9 @@ module Google
         ##
         # 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.
+        # must pass the `user_project` option to {Project#bucket} and
+        # {Project#buckets} to indicate the project to which the access costs
+        # should be billed.
         #
         # This feature is currently available only to whitelisted projects.
         #
@@ -359,8 +360,8 @@ module Google
         # 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.
+        # {Project#bucket} and {Project#buckets} to indicate the project to
+        # which the access costs should be billed.
         #
         # This feature is currently available only to whitelisted projects.
         #
@@ -376,7 +377,7 @@ module Google
         #
         #   bucket.requester_pays = true # API call
         #   # Other projects must now provide `user_project` option when calling
-        #   # Project#bucket to access this bucket.
+        #   # Project#bucket or Project#buckets to access this bucket.
         #
         def requester_pays= new_requester_pays
           @gapi.billing ||= Google::Apis::StorageV1::Bucket::Billing.new
@@ -1211,10 +1212,10 @@ module Google
         #   the notification. An optional list of additional attributes to
         #   attach to each Cloud Pub/Sub message published for the notification
         #   subscription.
-        # @param [Symbol, String] event_types The event types for the
-        #   notification subscription. If provided, messages will only be sent
-        #   for the listed event types. If empty, messages will be sent for all
-        #   event types.
+        # @param [Symbol, String, Array<Symbol, String>] event_types The event
+        #   types for the notification subscription. If provided, messages will
+        #   only be sent for the listed event types. If empty, messages will be
+        #   sent for all event types.
         #
         #   Acceptable values are:
         #
@@ -1240,15 +1241,15 @@ module Google
         # @param [Symbol, String, Boolean] payload The desired content of the
         #   Pub/Sub message payload. Acceptable values are:
         #
-        #   * `true` or `:json` - The Pub/Sub message payload will be a UTF-8
+        #   * `:json` or `true` - The Pub/Sub message payload will be a UTF-8
         #     string containing the [resource
         #     representation](https://cloud.google.com/storage/docs/json_api/v1/objects#resource-representations)
         #     of the file's metadata.
-        #   * `false` or `:none` - No payload is included with the notification.
+        #   * `:none` or `false` - No payload is included with the notification.
         #
         #   The default value is `:json`.
         #
-        # @return [Array<String>] The permissions held by the caller.
+        # @return [Google::Cloud::Storage::Notification]
         #
         # @example
         #   require "google/cloud/pubsub"

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

@@ -72,8 +72,9 @@ module Google
             return nil unless next?
             ensure_service!
             gapi = @service.list_buckets prefix: @prefix, token: @token,
-                                         max: @max
-            Bucket::List.from_gapi gapi, @service, @prefix, @max
+                                         max: @max, user_project: @user_project
+            Bucket::List.from_gapi gapi, @service, @prefix, @max,
+                                   user_project: @user_project
           end
 
           ##
@@ -144,14 +145,16 @@ 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
+          def self.from_gapi gapi_list, service, prefix = nil, max = nil,
+                             user_project: nil
             buckets = new(Array(gapi_list.items).map do |gapi_object|
-              Bucket.from_gapi gapi_object, service
+              Bucket.from_gapi gapi_object, service, user_project: user_project
             end)
             buckets.instance_variable_set :@token, gapi_list.next_page_token
             buckets.instance_variable_set :@service, service
             buckets.instance_variable_set :@prefix, prefix
             buckets.instance_variable_set :@max, max
+            buckets.instance_variable_set :@user_project, user_project
             buckets
           end
 

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

@@ -55,24 +55,18 @@ module Google
         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`.
+        # 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}.
+        # {Project#bucket} or {Project#buckets}.
         #
-        # 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.
+        # See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
         #
         # @example Setting a non-default project:
         #   require "google/cloud/storage"

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

@@ -24,10 +24,13 @@ module Google
       # Represents a Pub/Sub notification subscription for a Cloud Storage
       # bucket.
       #
+      # See {Bucket#create_notification}, {Bucket#notifications}, and
+      # {Bucket#notification}.
+      #
       # @see https://cloud.google.com/storage/docs/pubsub-notifications Cloud
       #   Pub/Sub Notifications for Google Cloud
       #
-      # @attr [String] bucket The name of the {Bucket} to which this
+      # @attr_reader [String] bucket The name of the {Bucket} to which this
       #   notification belongs.
       #
       # @example
@@ -99,8 +102,8 @@ module Google
         end
 
         ##
-        # The event types of this notification. If present, only send
-        # notifications about listed event types. If empty, sent notifications
+        # The event types of this notification. If present, messages will only
+        # be sent for the listed event types. If empty, messages will be sent
         # for all event types.
         #
         # The following is a list of event types currently supported by Cloud

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

@@ -93,6 +93,19 @@ module Google
         # @param [String] token A previously-returned page token representing
         #   part of the larger set of results to view.
         # @param [Integer] max Maximum number of buckets to return.
+        # @param [Boolean, String] user_project If this parameter is set to
+        #   `true`, transit costs for operations on the enabled buckets or their
+        #   files 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 value provided will be applied to all operations on the returned
+        #   bucket instances and their files.
+        #
+        #   See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
         #
         # @return [Array<Google::Cloud::Storage::Bucket>] (See
         #   {Google::Cloud::Storage::Bucket::List})
@@ -127,9 +140,11 @@ module Google
         #     puts bucket.name
         #   end
         #
-        def buckets prefix: nil, token: nil, max: nil
-          gapi = service.list_buckets prefix: prefix, token: token, max: max
-          Bucket::List.from_gapi gapi, service, prefix, max
+        def buckets prefix: nil, token: nil, max: nil, user_project: nil
+          gapi = service.list_buckets \
+            prefix: prefix, token: token, max: max, user_project: user_project
+          Bucket::List.from_gapi \
+            gapi, service, prefix, max, user_project: user_project
         end
         alias_method :find_buckets, :buckets
 
@@ -141,8 +156,7 @@ module Google
         #   without verifying the bucket resource exists on the Storage service.
         #   Calls made on this object will raise errors if the bucket resource
         #   does not exist. Default is `false`.
-        # @param [Boolean, String] user_project If the `requester_pays` flag is
-        #   enabled for the requested bucket, and if this parameter is set to
+        # @param [Boolean, String] user_project 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
@@ -151,8 +165,8 @@ module Google
         #   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.
+        #   The value provided will be applied to all operations on the returned
+        #   bucket instance and its files.
         #
         #   See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
         #
@@ -286,6 +300,16 @@ module Google
         #   does not exist. For more information, see [How to Host a Static
         #   Website
         #   ](https://cloud.google.com/storage/docs/website-configuration#step4).
+        # @param [String] user_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 value provided will be applied to all operations on the returned
+        #   bucket instance and its files.
+        #
+        #   See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
+        #
         # @yield [bucket] a block for configuring the bucket before it is
         #   created
         # @yieldparam [Bucket] cors the bucket object to be configured
@@ -317,7 +341,8 @@ module Google
         def create_bucket bucket_name, acl: nil, default_acl: nil,
                           location: nil, storage_class: nil,
                           logging_bucket: nil, logging_prefix: nil,
-                          website_main: nil, website_404: nil, versioning: nil
+                          website_main: nil, website_404: nil, versioning: nil,
+                          requester_pays: nil, user_project: nil
           new_bucket = Google::Apis::StorageV1::Bucket.new({
             name: bucket_name,
             location: location
@@ -330,13 +355,15 @@ module Google
             b.website_main = website_main unless website_main.nil?
             b.website_404 = website_404 unless website_404.nil?
             b.versioning = versioning unless versioning.nil?
+            b.requester_pays = requester_pays unless requester_pays.nil?
           end
           yield updater if block_given?
           updater.check_for_changed_labels!
           updater.check_for_mutable_cors!
           gapi = service.insert_bucket \
-            new_bucket, acl: acl_rule(acl), default_acl: acl_rule(default_acl)
-          Bucket.from_gapi gapi, service
+            new_bucket, acl: acl_rule(acl), default_acl: acl_rule(default_acl),
+                        user_project: user_project
+          Bucket.from_gapi gapi, service, user_project: user_project
         end
 
         ##

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

@@ -64,10 +64,11 @@ module Google
 
         ##
         # Retrieves a list of buckets for the given project.
-        def list_buckets prefix: nil, token: nil, max: nil
+        def list_buckets prefix: nil, token: nil, max: nil, user_project: nil
           execute do
-            service.list_buckets @project, prefix: prefix, page_token: token,
-                                           max_results: max
+            service.list_buckets \
+              @project, prefix: prefix, page_token: token, max_results: max,
+                        user_project: user_project(user_project)
           end
         end
 
@@ -84,12 +85,14 @@ module Google
         ##
         # Creates a new bucket.
         # Returns Google::Apis::StorageV1::Bucket.
-        def insert_bucket bucket_gapi, acl: nil, default_acl: nil
+        def insert_bucket bucket_gapi, acl: nil, default_acl: nil,
+                          user_project: nil
           execute do
             service.insert_bucket \
               @project, bucket_gapi,
               predefined_acl: acl,
-              predefined_default_object_acl: default_acl
+              predefined_default_object_acl: default_acl,
+              user_project: user_project(user_project)
           end
         end
 
@@ -471,8 +474,8 @@ module Google
         end
 
         # Pub/Sub notification subscription event_types
-        def event_types arr
-          arr.map { |x| event_type x } if arr
+        def event_types str_or_arr
+          Array(str_or_arr).map { |x| event_type x } if str_or_arr
         end
 
         # Pub/Sub notification subscription event_types

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Storage
-      VERSION = "1.5.0"
+      VERSION = "1.6.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-09-29 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.13.0
+        version: 0.14.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: digest-crc
   requirement: !ruby/object:Gem::Requirement