google-cloud-storage 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 785ee684ed3d6225bea9ef029a33739162b73482
-  data.tar.gz: 795d5c813467496884077148427406a138086e3d
+  metadata.gz: 234c7b1b0ea7f2033e0428c202ca6fc5a9390f68
+  data.tar.gz: 54912b87f802825f3d4a6a88126a20d826e382d3
 SHA512:
-  metadata.gz: 8d943e560150efb216a55999bcf327277bccf5b12329a6b382147a16a29e1509e4c722c28993bf1cd626b88f51b4cec4d444b141df3881fea2595a7b4e45262c
-  data.tar.gz: 1a74ee5f03dff72f2ab1cdb7568bab73cb6b7d5ece7818f310712b8dff0e67e0e9eccfe2c178c36c1dd51763008b20f59d0f08c757a08ce159c47e26fce8717b
+  metadata.gz: 4c813e0e7bae98753ad441d4a015ace5cab50d053821cbbcc0a64ab2fd4705f7f83707f122c225e8251816df667855098992485720c37b4ceff8dff2c55d768b
+  data.tar.gz: 0fde8c69671d845976c975aa67d6520d1421ff8e25ae8140625350e83bd9dd649eabd6fd31dc83aed6f0f0f6b32d3bb1456d493f67f3ea08f0e17705686dcf14

data/lib/google/cloud/storage.rb

@@ -439,8 +439,7 @@ module Google
     #
     # 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.
+    # transit costs related to the access.
     #
     # Assign transit costs for bucket and file operations to requesting clients
     # with the `requester_pays` flag:

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

@@ -48,23 +48,20 @@ module Google
         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`.
+        # A boolean value or a project ID string to indicate the project to
+        # be billed for operations on the 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 that project. This attribute is required with requester
+        # pays-enabled buckets. 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.
+        # See also {#requester_pays=} and {#requester_pays}.
         #
         # @example Setting a non-default project:
         #   require "google/cloud/storage"
@@ -346,8 +343,6 @@ module Google
         # {Project#buckets} 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.
         #
@@ -363,8 +358,6 @@ module Google
         # {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.
-        #
         # @param [Boolean] new_requester_pays When set to `true`, requester pays
         #   is enabled for the bucket.
         #
@@ -713,6 +706,116 @@ module Google
         alias_method :upload_file, :create_file
         alias_method :new_file, :create_file
 
+        ##
+        # Concatenates a list of existing files in the bucket into a new file in
+        # the bucket. There is a limit (currently 32) to the number of files
+        # that can be composed in a single operation.
+        #
+        # To compose files encrypted with a customer-supplied encryption key,
+        # use the `encryption_key` option. All source files must have been
+        # encrypted with the same key, and the resulting destination file will
+        # also be encrypted with the same key.
+        #
+        # @param [Array<String, Google::Cloud::Storage::File>] sources The list
+        #   of source file names or objects that will be concatenated into a
+        #   single file.
+        # @param [String] destination The name of the new file.
+        # @param [String] acl A predefined set of access controls to apply to
+        #   this file.
+        #
+        #   Acceptable values are:
+        #
+        #   * `auth`, `auth_read`, `authenticated`, `authenticated_read`,
+        #     `authenticatedRead` - File owner gets OWNER access, and
+        #     allAuthenticatedUsers get READER access.
+        #   * `owner_full`, `bucketOwnerFullControl` - File owner gets OWNER
+        #     access, and project team owners get OWNER access.
+        #   * `owner_read`, `bucketOwnerRead` - File owner gets OWNER access,
+        #     and project team owners get READER access.
+        #   * `private` - File owner gets OWNER access.
+        #   * `project_private`, `projectPrivate` - File owner gets OWNER
+        #     access, and project team members get access according to their
+        #     roles.
+        #   * `public`, `public_read`, `publicRead` - File owner gets OWNER
+        #     access, and allUsers get READER access.
+        #
+        # @param [String, nil] encryption_key Optional. The customer-supplied,
+        #   AES-256 encryption key used to encrypt the source files, if one was
+        #   used. All source files must have been encrypted with the same key,
+        #   and the resulting destination file will also be encrypted with the
+        #   key.
+        #
+        # @yield [file] A block yielding a delegate file object for setting the
+        #   properties of the destination file.
+        #
+        # @return [Google::Cloud::Storage::File] The new file.
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   sources = ["path/to/my-file-1.ext", "path/to/my-file-2.ext"]
+        #
+        #   new_file = bucket.compose sources, "path/to/new-file.ext"
+        #
+        # @example Set the properties of the new file in a block:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   sources = ["path/to/my-file-1.ext", "path/to/my-file-2.ext"]
+        #
+        #   new_file = bucket.compose sources, "path/to/new-file.ext" do |f|
+        #     f.cache_control = "private, max-age=0, no-cache"
+        #     f.content_disposition = "inline; filename=filename.ext"
+        #     f.content_encoding = "deflate"
+        #     f.content_language = "de"
+        #     f.content_type = "application/json"
+        #   end
+        #
+        # @example Specify the generation of source files (but skip retrieval):
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   file_1 = bucket.file "path/to/my-file-1.ext",
+        #                        generation: 1490390259479000, skip_lookup: true
+        #   file_2 = bucket.file "path/to/my-file-2.ext",
+        #                        generation: 1490310974144000, skip_lookup: true
+        #
+        #   new_file = bucket.compose [file_1, file_2], "path/to/new-file.ext"
+        #
+        def compose sources, destination, acl: nil, encryption_key: nil
+          ensure_service!
+          sources = Array sources
+          if sources.size < 2
+            fail ArgumentError, "must provide at least two source files"
+          end
+
+          options = { acl: File::Acl.predefined_rule_for(acl),
+                      key: encryption_key,
+                      user_project: user_project }
+          destination_gapi = nil
+          if block_given?
+            destination_gapi = Google::Apis::StorageV1::Object.new
+            updater = File::Updater.new destination_gapi
+            yield updater
+            updater.check_for_changed_metadata!
+          end
+          gapi = service.compose_file name, sources, destination,
+                                      destination_gapi, options
+          File.from_gapi gapi, service
+        end
+        alias_method :compose_file, :compose
+        alias_method :combine, :compose
+
         ##
         # Access without authentication can be granted to a File for a specified
         # period of time. This URL uses a cryptographic signature of your

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

@@ -49,24 +49,21 @@ module Google
                     "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`.
+          # A boolean value or a project ID string to indicate the project to
+          # be billed for operations on the 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 that project. This attribute is required with requester
+          # pays-enabled buckets. 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.
+          # See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
           #
           attr_accessor :user_project
 
@@ -476,24 +473,21 @@ module Google
                     "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`.
+          # A boolean value or a project ID string to indicate the project to
+          # be billed for operations on the 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 that project. This attribute is required with requester
+          # pays-enabled buckets. 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.
+          # See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
           #
           attr_accessor :user_project
 

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

@@ -60,7 +60,8 @@ module Google
         # {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`.
+        # billed to that project. This attribute is required with requester
+        # pays-enabled buckets. The default is `nil`.
         #
         # In general, this attribute should be set when first retrieving the
         # owning bucket by providing the `user_project` option to

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

@@ -51,24 +51,21 @@ module Google
                     "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`.
+          # A boolean value or a project ID string to indicate the project to
+          # be billed for operations on the 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 that project. This attribute is required with requester
+          # pays-enabled buckets. 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.
+          # See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
           #
           attr_accessor :user_project
 

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

@@ -60,7 +60,8 @@ module Google
         attr_accessor :gapi
 
         ##
-        # @private The project ID string for a requester pays bucket.
+        # @private A boolean value or a project ID string to indicate the
+        # project to be billed for operations.
         attr_accessor :user_project
 
         attr_reader :bucket

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

@@ -99,8 +99,8 @@ module Google
         #   {#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`.
+        #   transit costs will be billed to the given project. This parameter is
+        #   required with requester pays-enabled buckets. The default is `nil`.
         #
         #   The value provided will be applied to all operations on the returned
         #   bucket instances and their files.
@@ -162,7 +162,8 @@ module Google
         #   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
+        #   account, transit costs will be billed to the given project. This
+        #   parameter is required with requester pays-enabled buckets. The
         #   default is `nil`.
         #
         #   The value provided will be applied to all operations on the returned
@@ -181,7 +182,7 @@ module Google
         #   bucket = storage.bucket "my-bucket"
         #   puts bucket.name
         #
-        # @example With `user_project` set to pay for a requester pays bucket:
+        # @example With `user_project` set to bill costs to the default project:
         #   require "google/cloud/storage"
         #
         #   storage = Google::Cloud::Storage.new

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

@@ -347,6 +347,25 @@ module Google
           end
         end
 
+        ## Copy a file from source bucket/object to a
+        # destination bucket/object.
+        def compose_file bucket_name, source_files, destination_path,
+                         destination_gapi, acl: nil, key: nil, user_project: nil
+
+          compose_req = Google::Apis::StorageV1::ComposeRequest.new \
+            source_objects: compose_file_source_objects(source_files),
+            destination: destination_gapi
+
+          execute do
+            service.compose_object \
+              bucket_name, destination_path,
+              compose_req,
+              destination_predefined_acl: acl,
+              user_project: user_project(user_project),
+              options: key_options(key)
+          end
+        end
+
         ##
         # Download contents of a file.
         def download_file bucket_name, file_path, target_path, generation: nil,
@@ -504,6 +523,19 @@ module Google
             "false" => "NONE" }[str_or_bool.to_s.downcase]
         end
 
+        def compose_file_source_objects source_files
+          source_files.map do |file|
+            if file.is_a? Google::Cloud::Storage::File
+              Google::Apis::StorageV1::ComposeRequest::SourceObject.new \
+                name: file.name,
+                generation: file.generation
+            else
+              Google::Apis::StorageV1::ComposeRequest::SourceObject.new \
+                name: file
+            end
+          end
+        end
+
         def execute
           yield
         rescue Google::Apis::Error => e

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-29 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage