google-cloud-storage 1.13.0 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 005b0793cbed00c606d35b048008ab0621d10b7a17a5c7bddb8c7394a20af699
-  data.tar.gz: 04c41b836c797cc2b57d4f6bf877d4c85e9643cd9bb1d6c3bf9257187b505410
+  metadata.gz: 2ce659678f9b9f504dd5836bd4985ef9b92f9f6bc41e9ef7919effbed5967ad0
+  data.tar.gz: b4bdce219f6973d4f1ad1ba28501549b0c21ceb2b4fba993ecad37a972b18316
 SHA512:
-  metadata.gz: 8b457e4df6fdae134b017fbb78b539d7549679b80cb6c67ab44c3299a011fe918869b1cfc5b6a5d35de6f600db01ca405920afa4f049a86e05358a964d2358c3
-  data.tar.gz: 48d8ed7a3c98364256e780d3d9d9d87498354d3a1f237a35397835d3d501daf228366f31f081ea4c71e5101f3c2c7b4f0b73beb52b7d8a6c214782d372313ecd
+  metadata.gz: 8ffdeb63b4ecb7aa95644e00ae5d60e244706814e2667314f00448a7cb42b677c4b0ceb8f64bae464984af82108d1fea2953539e77c985e18f381d56251acffe
+  data.tar.gz: 248716f033cdda7a205ed1711585d637be2a8dce3b6f0888e5ad1bb83da28ac06423115e93e7f4f266a4e9c327984c80036d42f87ebbdcdb99dfc0ce6be718a1

data/.yardopts

@@ -1,6 +1,7 @@
 --no-private
 --title=Google Cloud Storage
 --markup markdown
+--markup-provider redcarpet
 
 ./lib/**/*.rb
 -

data/README.md

@@ -60,14 +60,14 @@ Google::Apis.logger = my_logger
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.0+.
-
-However, Ruby 2.3 or later is strongly recommended, as earlier releases have
-reached or are nearing end-of-life. After June 1, 2018, Google will provide
-official support only for Ruby versions that are considered current and
-supported by Ruby Core (that is, Ruby versions that are either in normal
-maintenance or in security maintenance).
-See https://www.ruby-lang.org/en/downloads/branches/ for further details.
+This library is supported on Ruby 2.3+.
+
+Google provides official support for Ruby versions that are actively supported
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or
+in security maintenance, and not end of life. Currently, this means Ruby 2.3
+and later. Older versions of Ruby _may_ still work, but are unsupported and not
+recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
+about the Ruby support schedule.
 
 ## Versioning
 

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

@@ -86,30 +86,45 @@ module Google
         ##
         # The kind of item this is.
         # For buckets, this is always `storage#bucket`.
+        #
+        # @return [String]
+        #
         def kind
           @gapi.kind
         end
 
         ##
         # The ID of the bucket.
+        #
+        # @return [String]
+        #
         def id
           @gapi.id
         end
 
         ##
         # The name of the bucket.
+        #
+        # @return [String]
+        #
         def name
           @gapi.name
         end
 
         ##
         # A URL that can be used to access the bucket using the REST API.
+        #
+        # @return [String]
+        #
         def api_url
           @gapi.self_link
         end
 
         ##
         # Creation time of the bucket.
+        #
+        # @return [DateTime]
+        #
         def created_at
           @gapi.time_created
         end
@@ -131,6 +146,8 @@ module Google
         # @yield [cors] a block for setting CORS rules
         # @yieldparam [Bucket::Cors] cors the object accepting CORS rules
         #
+        # @return [Bucket::Cors] The frozen builder object.
+        #
         # @example Retrieving the bucket's CORS rules.
         #   require "google/cloud/storage"
         #
@@ -177,7 +194,10 @@ module Google
         # storage within this region. Defaults to US.
         # See the developer's guide for the authoritative list.
         #
+        # @return [String]
+        #
         # @see https://cloud.google.com/storage/docs/concepts-techniques
+        #
         def location
           @gapi.location
         end
@@ -185,6 +205,8 @@ module Google
         ##
         # The destination bucket name for the bucket's logs.
         #
+        # @return [String]
+        #
         # @see https://cloud.google.com/storage/docs/access-logs Access Logs
         #
         def logging_bucket
@@ -209,6 +231,8 @@ module Google
         #
         # @see https://cloud.google.com/storage/docs/access-logs Access Logs
         #
+        # @return [String]
+        #
         def logging_prefix
           @gapi.logging.log_object_prefix if @gapi.logging
         end
@@ -223,6 +247,8 @@ module Google
         #
         # @see https://cloud.google.com/storage/docs/access-logs Access Logs
         #
+        # @param [String] logging_prefix The logging object prefix.
+        #
         def logging_prefix= logging_prefix
           @gapi.logging ||= Google::Apis::StorageV1::Bucket::Logging.new
           @gapi.logging.log_object_prefix = logging_prefix
@@ -234,6 +260,9 @@ module Google
         # stored and determines the SLA and the cost of storage. Values include
         # `MULTI_REGIONAL`, `REGIONAL`, `NEARLINE`, `COLDLINE`, and
         # `DURABLE_REDUCED_AVAILABILITY`.
+        #
+        # @return [String]
+        #
         def storage_class
           @gapi.storage_class
         end
@@ -245,7 +274,9 @@ module Google
         # and `:coldline`, as well as the equivalent strings returned by
         # {Bucket#storage_class}. For more information, see [Storage
         # Classes](https://cloud.google.com/storage/docs/storage-classes).
+        #
         # @param [Symbol, String] new_storage_class Storage class of the bucket.
+        #
         def storage_class= new_storage_class
           @gapi.storage_class = storage_class_for(new_storage_class)
           patch_gapi! :storage_class
@@ -255,6 +286,9 @@ module Google
         # Whether [Object
         # Versioning](https://cloud.google.com/storage/docs/object-versioning)
         # is enabled for the bucket.
+        #
+        # @return [Boolean]
+        #
         def versioning?
           @gapi.versioning.enabled? unless @gapi.versioning.nil?
         end
@@ -264,7 +298,8 @@ module Google
         # Versioning](https://cloud.google.com/storage/docs/object-versioning)
         # is enabled for the bucket.
         #
-        # @return [Boolean]
+        # @param [Boolean] new_versioning true if versioning is to be enabled
+        #   for the bucket.
         #
         def versioning= new_versioning
           @gapi.versioning ||= Google::Apis::StorageV1::Bucket::Versioning.new
@@ -273,23 +308,29 @@ module Google
         end
 
         ##
-        # The index page returned from a static website served from the bucket
-        # when a site visitor requests the top level directory.
+        # The main page suffix for a static website. If the requested object
+        # path is missing, the service will ensure the path has a trailing '/',
+        # append this suffix, and attempt to retrieve the resulting object. This
+        # allows the creation of index.html objects to represent directory
+        # pages.
         #
         # @see https://cloud.google.com/storage/docs/website-configuration#step4
         #   How to Host a Static Website
         #
+        # @return [String] The main page suffix.
+        #
         def website_main
           @gapi.website.main_page_suffix if @gapi.website
         end
 
         ##
-        # Updates the index page returned from a static website served from the
-        # bucket when a site visitor requests the top level directory.
+        # Updates the main page suffix for a static website.
         #
         # @see https://cloud.google.com/storage/docs/website-configuration#step4
         #   How to Host a Static Website
         #
+        # @param [String] website_main The main page suffix.
+        #
         def website_main= website_main
           @gapi.website ||= Google::Apis::StorageV1::Bucket::Website.new
           @gapi.website.main_page_suffix = website_main
@@ -303,6 +344,8 @@ module Google
         # @see https://cloud.google.com/storage/docs/website-configuration#step4
         #   How to Host a Static Website
         #
+        # @return [String]
+        #
         def website_404
           @gapi.website.not_found_page if @gapi.website
         end
@@ -310,6 +353,9 @@ module Google
         ##
         # A hash of user-provided labels. The hash is frozen and changes are not
         # allowed.
+        #
+        # @return [Hash(String => String)]
+        #
         def labels
           m = @gapi.labels
           m = m.to_h if m.respond_to? :to_h
@@ -318,6 +364,9 @@ module Google
 
         ##
         # Updates the hash of user-provided labels.
+        #
+        # @param [Hash(String => String)] labels The user-provided labels.
+        #
         def labels= labels
           @gapi.labels = labels
           patch_gapi! :labels
@@ -406,7 +455,7 @@ module Google
         # Set the Cloud KMS encryption key that will be used to protect files.
         # For example: `projects/a/locations/b/keyRings/c/cryptoKeys/d`
         #
-        # @param [String] new_default_kms_key New Cloud KMS key name
+        # @param [String] new_default_kms_key New Cloud KMS key name.
         #
         # @example
         #   require "google/cloud/storage"
@@ -972,6 +1021,8 @@ module Google
         #   corresponding values. (These values can be permanently set using
         #   {File#content_disposition=} and {File#content_type=}.)
         #
+        # @return [String]
+        #
         # @example
         #   require "google/cloud/storage"
         #
@@ -1136,7 +1187,7 @@ module Google
         end
 
         ##
-        # The Bucket::Acl instance used to control access to the bucket.
+        # The {Bucket::Acl} instance used to control access to the bucket.
         #
         # A bucket has owners, writers, and readers. Permissions can be granted
         # to an individual user's email address, a group's email address, as
@@ -1145,6 +1196,8 @@ module Google
         # @see https://cloud.google.com/storage/docs/access-control Access
         #   Control guide
         #
+        # @return [Bucket::Acl]
+        #
         # @example Grant access to a user by prepending `"user-"` to an email:
         #   require "google/cloud/storage"
         #
@@ -1179,8 +1232,8 @@ module Google
         end
 
         ##
-        # The Bucket::DefaultAcl instance used to control access to the bucket's
-        # files.
+        # The {Bucket::DefaultAcl} instance used to control access to the
+        # bucket's files.
         #
         # A bucket's files have owners, writers, and readers. Permissions can be
         # granted to an individual user's email address, a group's email
@@ -1189,6 +1242,8 @@ module Google
         # @see https://cloud.google.com/storage/docs/access-control Access
         #   Control guide
         #
+        # @return [Bucket::DefaultAcl]
+        #
         # @example Grant access to a user by prepending `"user-"` to an email:
         #   require "google/cloud/storage"
         #
@@ -1490,6 +1545,7 @@ module Google
 
         ##
         # Reloads the bucket with current data from the Storage service.
+        #
         def reload!
           ensure_service!
           @gapi = service.get_bucket name, user_project: user_project
@@ -1501,6 +1557,9 @@ module Google
 
         ##
         # Determines whether the bucket exists in the Storage service.
+        #
+        # @return [Boolean] true if the bucket exists in the Storage service.
+        #
         def exists?
           # Always true if we have a grpc object
           return true unless lazy?
@@ -1607,12 +1666,18 @@ module Google
 
           ##
           # A hash of user-provided labels. Changes are allowed.
+          #
+          # @return [Hash(String => String)]
+          #
           def labels
             @labels
           end
 
           ##
           # Updates the hash of user-provided labels.
+          #
+          # @param [Hash(String => String)] labels The user-provided labels.
+          #
           def labels= labels
             @labels = labels
             @gapi.labels = @labels

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

@@ -172,6 +172,8 @@ module Google
           #   * allUsers
           #   * allAuthenticatedUsers
           #
+          # @return [String] The entity.
+          #
           # @example Grant access to a user by prepending `"user-"` to an email:
           #   require "google/cloud/storage"
           #
@@ -215,6 +217,8 @@ module Google
           #   * allUsers
           #   * allAuthenticatedUsers
           #
+          # @return [String] The entity.
+          #
           # @example Grant access to a user by prepending `"user-"` to an email:
           #   require "google/cloud/storage"
           #
@@ -258,6 +262,8 @@ module Google
           #   * allUsers
           #   * allAuthenticatedUsers
           #
+          # @return [String] The entity.
+          #
           # @example Grant access to a user by prepending `"user-"` to an email:
           #   require "google/cloud/storage"
           #
@@ -302,6 +308,8 @@ module Google
           #   * allUsers
           #   * allAuthenticatedUsers
           #
+          # @return [Boolean]
+          #
           # @example
           #   require "google/cloud/storage"
           #

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

@@ -108,24 +108,36 @@ module Google
         ##
         # The kind of item this is.
         # For files, this is always storage#object.
+        #
+        # @return [String]
+        #
         def kind
           @gapi.kind
         end
 
         ##
         # The ID of the file.
+        #
+        # @return [String]
+        #
         def id
           @gapi.id
         end
 
         ##
         # The name of this file.
+        #
+        # @return [String]
+        #
         def name
           @gapi.name
         end
 
         ##
         # The name of the {Bucket} containing this file.
+        #
+        # @return [String]
+        #
         def bucket
           @gapi.bucket
         end
@@ -133,6 +145,9 @@ module Google
         ##
         # The content generation of this file.
         # Used for object versioning.
+        #
+        # @return [Fixnum]
+        #
         def generation
           @gapi.generation
         end
@@ -142,30 +157,45 @@ module Google
         # Used for preconditions and for detecting changes in metadata.
         # A metageneration number is only meaningful in the context of a
         # particular generation of a particular file.
+        #
+        # @return [Fixnum]
+        #
         def metageneration
           @gapi.metageneration
         end
 
         ##
         # A URL that can be used to access the file using the REST API.
+        #
+        # @return [String]
+        #
         def api_url
           @gapi.self_link
         end
 
         ##
         # A URL that can be used to download the file using the REST API.
+        #
+        # @return [String]
+        #
         def media_url
           @gapi.media_link
         end
 
         ##
         # Content-Length of the data in bytes.
+        #
+        # @return [Integer]
+        #
         def size
           @gapi.size.to_i if @gapi.size
         end
 
         ##
         # Creation time of the file.
+        #
+        # @return [DateTime]
+        #
         def created_at
           @gapi.time_created
         end
@@ -174,12 +204,18 @@ module Google
         # The creation or modification time of the file.
         # For buckets with versioning enabled, changing an object's
         # metadata does not change this property.
+        #
+        # @return [DateTime]
+        #
         def updated_at
           @gapi.updated
         end
 
         ##
         # MD5 hash of the data; encoded using base64.
+        #
+        # @return [String]
+        #
         def md5
           @gapi.md5_hash
         end
@@ -188,19 +224,29 @@ module Google
         # The CRC32c checksum of the data, as described in
         # [RFC 4960, Appendix B](http://tools.ietf.org/html/rfc4960#appendix-B).
         # Encoded using base64 in big-endian byte order.
+        #
+        # @return [String]
+        #
         def crc32c
           @gapi.crc32c
         end
 
         ##
         # HTTP 1.1 Entity tag for the file.
+        #
+        # @return [String]
+        #
         def etag
           @gapi.etag
         end
 
         ##
         # The [Cache-Control](https://tools.ietf.org/html/rfc7234#section-5.2)
-        # directive for the file data.
+        # directive for the file data. If omitted, and the file is accessible
+        # to all anonymous users, the default will be `public, max-age=3600`.
+        #
+        # @return [String]
+        #
         def cache_control
           @gapi.cache_control
         end
@@ -208,7 +254,11 @@ module Google
         ##
         # Updates the
         # [Cache-Control](https://tools.ietf.org/html/rfc7234#section-5.2)
-        # directive for the file data.
+        # directive for the file data. If omitted, and the file is accessible
+        # to all anonymous users, the default will be `public, max-age=3600`.
+        #
+        # @param [String] cache_control The Cache-Control directive.
+        #
         def cache_control= cache_control
           @gapi.cache_control = cache_control
           update_gapi! :cache_control
@@ -217,6 +267,9 @@ module Google
         ##
         # The [Content-Disposition](https://tools.ietf.org/html/rfc6266) of the
         # file data.
+        #
+        # @return [String]
+        #
         def content_disposition
           @gapi.content_disposition
         end
@@ -224,6 +277,10 @@ module Google
         ##
         # Updates the [Content-Disposition](https://tools.ietf.org/html/rfc6266)
         # of the file data.
+        #
+        # @param [String] content_disposition The Content-Disposition of the
+        #   file.
+        #
         def content_disposition= content_disposition
           @gapi.content_disposition = content_disposition
           update_gapi! :content_disposition
@@ -233,6 +290,9 @@ module Google
         # The [Content-Encoding
         # ](https://tools.ietf.org/html/rfc7231#section-3.1.2.2) of the file
         # data.
+        #
+        # @return [String]
+        #
         def content_encoding
           @gapi.content_encoding
         end
@@ -241,6 +301,9 @@ module Google
         # Updates the [Content-Encoding
         # ](https://tools.ietf.org/html/rfc7231#section-3.1.2.2) of the file
         # data.
+        #
+        # @param [String] content_encoding The Content-Encoding of the file.
+        #
         def content_encoding= content_encoding
           @gapi.content_encoding = content_encoding
           update_gapi! :content_encoding
@@ -249,6 +312,9 @@ module Google
         ##
         # The [Content-Language](http://tools.ietf.org/html/bcp47) of the file
         # data.
+        #
+        # @return [String]
+        #
         def content_language
           @gapi.content_language
         end
@@ -256,6 +322,9 @@ module Google
         ##
         # Updates the [Content-Language](http://tools.ietf.org/html/bcp47) of
         # the file data.
+        #
+        # @param [String] content_language The Content-Language of the file.
+        #
         def content_language= content_language
           @gapi.content_language = content_language
           update_gapi! :content_language
@@ -264,6 +333,9 @@ module Google
         ##
         # The [Content-Type](https://tools.ietf.org/html/rfc2616#section-14.17)
         # of the file data.
+        #
+        # @return [String]
+        #
         def content_type
           @gapi.content_type
         end
@@ -272,6 +344,9 @@ module Google
         # Updates the
         # [Content-Type](https://tools.ietf.org/html/rfc2616#section-14.17) of
         # the file data.
+        #
+        # @param [String] content_type The Content-Type of the file.
+        #
         def content_type= content_type
           @gapi.content_type = content_type
           update_gapi! :content_type
@@ -281,6 +356,9 @@ module Google
         # A hash of custom, user-provided web-safe keys and arbitrary string
         # values that will returned with requests for the file as "x-goog-meta-"
         # response headers.
+        #
+        # @return [Hash(String => String)]
+        #
         def metadata
           m = @gapi.metadata
           m = m.to_h if m.respond_to? :to_h
@@ -291,6 +369,10 @@ module Google
         # Updates the hash of custom, user-provided web-safe keys and arbitrary
         # string values that will returned with requests for the file as
         # "x-goog-meta-" response headers.
+        #
+        # @param [Hash(String => String)] metadata The user-provided metadata,
+        #   in key/value pairs.
+        #
         def metadata= metadata
           @gapi.metadata = metadata
           update_gapi! :metadata
@@ -303,6 +385,9 @@ module Google
         # key](https://cloud.google.com/storage/docs/encryption#customer-supplied).
         # You can use this SHA256 hash to uniquely identify the AES-256
         # encryption key required to decrypt this file.
+        #
+        # @return [String]
+        #
         def encryption_key_sha256
           return nil unless @gapi.customer_encryption
           Base64.decode64 @gapi.customer_encryption.key_sha256
@@ -318,9 +403,6 @@ module Google
         # @return [String, nil] A Cloud KMS encryption key, or `nil` if none has
         #   been configured.
         #
-        # @see https://cloud.google.com/kms/docs/ Cloud Key Management Service
-        #   Documentation
-        #
         def kms_key
           @gapi.kms_key_name
         end
@@ -332,6 +414,9 @@ module Google
         # Classes](https://cloud.google.com/storage/docs/storage-classes) and
         # [Per-Object Storage
         # Class](https://cloud.google.com/storage/docs/per-object-storage-class).
+        #
+        # @return [String]
+        #
         def storage_class
           @gapi.storage_class
         end
@@ -352,7 +437,9 @@ module Google
         # Class](https://cloud.google.com/storage/docs/per-object-storage-class).
         # The  default value is the default storage class for the bucket. See
         # {Bucket#storage_class}.
+        #
         # @param [Symbol, String] storage_class Storage class of the file.
+        #
         def storage_class= storage_class
           @gapi.storage_class = storage_class_for(storage_class)
           update_gapi! :storage_class
@@ -366,7 +453,7 @@ module Google
         # version. You can turn versioning on or off for a bucket at any time
         # with {Bucket#versioning=}. Turning versioning off leaves existing file
         # versions in place and causes the bucket to stop accumulating new
-        # archived object versions. (See {Bucket#versioning} and
+        # archived object versions. (See {Bucket#versioning?} and
         # {File#generation})
         #
         # @see https://cloud.google.com/storage/docs/object-versioning Object
@@ -952,12 +1039,12 @@ module Google
         ##
         # Permanently deletes the file.
         #
-        # @return [Boolean] Returns `true` if the file was deleted.
         # @param [Boolean, Integer] generation Specify a version of the file to
         #   delete. When `true`, it will delete the version returned by
         #   {#generation}. The default behavior is to delete the latest version
         #   of the file (regardless of the version to which the file is set,
         #   which is the version returned by {#generation}.)
+        # @return [Boolean] Returns `true` if the file was deleted.
         #
         # @example
         #   require "google/cloud/storage"
@@ -1009,6 +1096,8 @@ module Google
         # @param [String] protocol The protocol to use for the URL. Default is
         #   `HTTPS`.
         #
+        # @return [String]
+        #
         # @example
         #   require "google/cloud/storage"
         #
@@ -1081,6 +1170,8 @@ module Google
         #   corresponding values. (These values can be permanently set using
         #   {#content_disposition=} and {#content_type=}.)
         #
+        # @return [String]
+        #
         # @example
         #   require "google/cloud/storage"
         #
@@ -1149,6 +1240,8 @@ module Google
         # @see https://cloud.google.com/storage/docs/access-control Access
         #   Control guide
         #
+        # @return [File::Acl]
+        #
         # @example Grant access to a user by prepending `"user-"` to an email:
         #   require "google/cloud/storage"
         #
@@ -1423,6 +1516,9 @@ module Google
           # A hash of custom, user-provided web-safe keys and arbitrary string
           # values that will returned with requests for the file as
           # "x-goog-meta-" response headers.
+          #
+          # @return [Hash(String => String)]
+          #
           def metadata
             @metadata
           end
@@ -1431,6 +1527,10 @@ module Google
           # Updates the hash of custom, user-provided web-safe keys and
           # arbitrary string values that will returned with requests for the
           # file as "x-goog-meta-" response headers.
+          #
+          # @param [Hash(String => String)] metadata The user-provided metadata,
+          #   in key/value pairs.
+          #
           def metadata= metadata
             @metadata = metadata
             @gapi.metadata = @metadata

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

@@ -161,6 +161,8 @@ module Google
           # @param [Integer] generation When present, selects a specific
           #   revision of this object. Default is the latest version.
           #
+          # @return [String] The entity.
+          #
           # @example Grant access to a user by prepending `"user-"` to an email:
           #   require "google/cloud/storage"
           #
@@ -210,6 +212,8 @@ module Google
           # @param [Integer] generation When present, selects a specific
           #   revision of this object. Default is the latest version.
           #
+          # @return [String] The entity.
+          #
           # @example Grant access to a user by prepending `"user-"` to an email:
           #   require "google/cloud/storage"
           #
@@ -259,6 +263,9 @@ module Google
           # @param [Integer] generation When present, selects a specific
           #   revision of this object. Default is the latest version.
           #
+          # @return [Boolean] true if the delete operation did not raise an
+          #   error
+          #
           # @example
           #   require "google/cloud/storage"
           #

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

@@ -78,18 +78,27 @@ module Google
         ##
         # The kind of item this is.
         # For notifications, this is always storage#notification.
+        #
+        # @return [String]
+        #
         def kind
           @gapi.kind
         end
 
         ##
         # The ID of the notification.
+        #
+        # @return [String]
+        #
         def id
           @gapi.id
         end
 
         ##
         # A URL that can be used to access the notification using the REST API.
+        #
+        # @return [String]
+        #
         def api_url
           @gapi.self_link
         end
@@ -98,6 +107,9 @@ module Google
         # The custom attributes of this notification. An optional list of
         # additional attributes to attach to each Cloud Pub/Sub message
         # published for this notification subscription.
+        #
+        # @return [Hash(String => String)]
+        #
         def custom_attrs
           @gapi.custom_attributes
         end
@@ -133,6 +145,8 @@ module Google
         # explicitly specify in their notification configuration which event
         # types they are prepared to accept.
         #
+        # @return [Array<String>]
+        #
         def event_types
           @gapi.event_types
         end
@@ -142,6 +156,8 @@ module Google
         # this notification configuration to file names that begin with this
         # prefix.
         #
+        # @return [String]
+        #
         def prefix
           @gapi.object_name_prefix
         end
@@ -156,6 +172,8 @@ module Google
         #   of the file's metadata.
         # * `NONE` - No payload is included with the notification.
         #
+        # @return [String]
+        #
         def payload
           @gapi.payload_format
         end
@@ -164,6 +182,9 @@ module Google
         # The Cloud Pub/Sub topic to which this subscription publishes.
         # Formatted as:
         # `//pubsub.googleapis.com/projects/{project-id}/topics/{my-topic}`
+        #
+        # @return [String]
+        #
         def topic
           @gapi.topic
         end

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

@@ -175,7 +175,7 @@ module Google
             roles_dup = p.roles.each_with_object({}) do |(k, v), memo|
               memo[k] = v.dup rescue value
             end
-            p.instance_variable_set "@roles", roles_dup
+            p.instance_variable_set :@roles, roles_dup
           end
         end
 

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

@@ -61,6 +61,8 @@ module Google
         ##
         # The Storage project connected to.
         #
+        # @return [String]
+        #
         # @example
         #   require "google/cloud/storage"
         #
@@ -76,6 +78,18 @@ module Google
         end
         alias project project_id
 
+        ##
+        # The Google Cloud Storage managed service account created for the
+        # project used to initialize the client library. (See also
+        # {#project_id}.)
+        #
+        # @return [String] The service account email address.
+        #
+        def service_account_email
+          @service_account_email ||= \
+            service.project_service_account.email_address
+        end
+
         ##
         # Retrieves a list of buckets for the given project.
         #
@@ -411,6 +425,8 @@ module Google
         #   corresponding values. (These values can be permanently set using
         #   {File#content_disposition=} and {File#content_type=}.)
         #
+        # @return [String]
+        #
         # @example
         #   require "google/cloud/storage"
         #

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

@@ -63,6 +63,10 @@ module Google
         end
         attr_accessor :mocked_service
 
+        def project_service_account
+          service.get_project_service_account project
+        end
+
         ##
         # Retrieves a list of buckets for the given project.
         def list_buckets prefix: nil, token: nil, max: nil, user_project: nil
@@ -558,6 +562,8 @@ module Google
 
   # rubocop:disable all
 
+  # @private
+  #
   # IMPORTANT: These monkey-patches of Apis::StorageV1::StorageService and
   # Apis::Core::DownloadCommand must be verified and updated (if needed) for
   # every upgrade of google-api-client.
@@ -569,7 +575,9 @@ module Google
   # solution instead.
   #
   module Apis
+    # @private
     module StorageV1
+      # @private
       class StorageService
         # Returns a two-element array containing:
         #   * The `result` that is the usual return type of #get_object.
@@ -613,7 +621,9 @@ module Google
         end
       end
     end
+    # @private
     module Core
+      # @private
       # Streaming/resumable media download support
       class DownloadCommand < ApiCommand
         # Returns a two-element array containing:

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.13.1
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -137,6 +137,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement