google-cloud-storage 1.9.0 → 1.10.0

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

@@ -1,10 +1,10 @@
-# Copyright 2017 Google Inc. All rights reserved.
+# Copyright 2017 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -208,7 +208,7 @@ module Google
         ##
         # Raise an error unless an active service is available.
         def ensure_service!
-          fail "Must have active connection" unless service
+          raise "Must have active connection" unless service
         end
       end
     end

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

@@ -1,10 +1,10 @@
-# Copyright 2017 Google Inc. All rights reserved.
+# Copyright 2017 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -199,7 +199,7 @@ module Google
         # @private New Policy from a
         # Google::Apis::StorageV1::Policy object.
         def self.from_gapi gapi
-          roles = gapi.bindings.each_with_object({}) do |binding, memo|
+          roles = Array(gapi.bindings).each_with_object({}) do |binding, memo|
             memo[binding.role] = binding.members.to_a
           end
           new gapi.etag, roles

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

@@ -1,10 +1,10 @@
-# Copyright 2014 Google Inc. All rights reserved.
+# Copyright 2014 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

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

@@ -1,10 +1,10 @@
-# Copyright 2014 Google Inc. All rights reserved.
+# Copyright 2014 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -13,7 +13,6 @@
 # limitations under the License.
 
 
-require "google/cloud/env"
 require "google/cloud/storage/errors"
 require "google/cloud/storage/service"
 require "google/cloud/storage/credentials"
@@ -75,16 +74,7 @@ module Google
         def project_id
           service.project
         end
-        alias_method :project, :project_id
-
-        ##
-        # @private Default project.
-        def self.default_project_id
-          ENV["STORAGE_PROJECT"] ||
-            ENV["GOOGLE_CLOUD_PROJECT"] ||
-            ENV["GCLOUD_PROJECT"] ||
-            Google::Cloud.env.project_id
-        end
+        alias project project_id
 
         ##
         # Retrieves a list of buckets for the given project.
@@ -147,7 +137,7 @@ module Google
           Bucket::List.from_gapi \
             gapi, service, prefix, max, user_project: user_project
         end
-        alias_method :find_buckets, :buckets
+        alias find_buckets buckets
 
         ##
         # Retrieves bucket by name.
@@ -210,7 +200,7 @@ module Google
         rescue Google::Cloud::NotFoundError
           nil
         end
-        alias_method :find_bucket, :bucket
+        alias find_bucket bucket
 
         ##
         # Creates a new bucket with optional attributes. Also accepts a block

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

@@ -1,10 +1,10 @@
-# Copyright 2014 Google Inc. All rights reserved.
+# Copyright 2014 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -48,10 +48,12 @@ module Google
           @service.client_options.open_timeout_sec = timeout
           @service.client_options.read_timeout_sec = timeout
           @service.client_options.send_timeout_sec = timeout
+          @service.client_options.transparent_gzip_decompression = false
           @service.request_options.retries = retries || 3
           @service.request_options.header ||= {}
           @service.request_options.header["x-goog-api-client"] = \
             "gl-ruby/#{RUBY_VERSION} gccl/#{Google::Cloud::Storage::VERSION}"
+          @service.request_options.header["Accept-Encoding"] = "gzip"
           @service.authorization = @credentials.client if @credentials
         end
 
@@ -133,8 +135,9 @@ module Google
         ##
         # Creates a new bucket ACL.
         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? })
+          new_acl = Google::Apis::StorageV1::BucketAccessControl.new(
+            { entity: entity, role: role }.delete_if { |_k, v| v.nil? }
+          )
           execute do
             service.insert_bucket_access_control \
               bucket_name, new_acl, user_project: user_project(user_project)
@@ -162,8 +165,9 @@ module Google
         ##
         # Creates a new default ACL.
         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? })
+          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, user_project: user_project(user_project)
@@ -222,12 +226,13 @@ module Google
         def insert_notification bucket_name, topic_name, custom_attrs: nil,
                                 event_types: nil, prefix: nil, payload: nil,
                                 user_project: nil
-          new_notification = Google::Apis::StorageV1::Notification.new({
-            custom_attributes: custom_attrs,
-            event_types: event_types(event_types),
-            object_name_prefix: prefix,
-            payload_format: payload_format(payload),
-            topic: topic_path(topic_name) }.delete_if { |_k, v| v.nil? })
+          new_notification = Google::Apis::StorageV1::Notification.new(
+            { custom_attributes: custom_attrs,
+              event_types: event_types(event_types),
+              object_name_prefix: prefix,
+              payload_format: payload_format(payload),
+              topic: topic_path(topic_name) }.delete_if { |_k, v| v.nil? }
+          )
 
           execute do
             service.insert_notification \
@@ -274,12 +279,13 @@ module Google
                         content_encoding: nil, content_language: nil,
                         content_type: nil, crc32c: nil, md5: nil, metadata: 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,
-            content_encoding: content_encoding, crc32c: crc32c,
-            content_language: content_language, metadata: metadata,
-            storage_class: storage_class }.delete_if { |_k, v| v.nil? })
+          file_obj = Google::Apis::StorageV1::Object.new(
+            { cache_control: cache_control, content_type: content_type,
+              content_disposition: content_disposition, md5_hash: md5,
+              content_encoding: content_encoding, crc32c: crc32c,
+              content_language: content_language, metadata: metadata,
+              storage_class: storage_class }.delete_if { |_k, v| v.nil? }
+          )
           content_type ||= mime_type_for(path || Pathname(source).to_path)
 
           execute do
@@ -367,14 +373,22 @@ module Google
 
         ##
         # Download contents of a file.
+        #
+        # Returns a two-element array containing:
+        #   * The IO object that is the usual return type of
+        #     StorageService#get_object (for downloads)
+        #   * The `http_resp` accessed via the monkey-patches of
+        #     Apis::StorageV1::StorageService and Apis::Core::DownloadCommand at
+        #     the end of this file.
         def download_file bucket_name, file_path, target_path, generation: nil,
                           key: nil, user_project: nil
+          options = key_options key
           execute do
-            service.get_object \
+            service.get_object_with_response \
               bucket_name, file_path,
               download_dest: target_path, generation: generation,
               user_project: user_project(user_project),
-              options: key_options(key)
+              options: options
           end
         end
 
@@ -415,8 +429,9 @@ module Google
         # Creates a new file ACL.
         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? })
+          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,
@@ -543,4 +558,154 @@ module Google
       end
     end
   end
+
+  # rubocop:disable all
+
+  # 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.
+  #
+  # The purpose of these modifications is to provide access to response headers
+  # (in particular, the Content-Encoding header) for the #download_file method,
+  # above. If google-api-client is modified to expose response headers to its
+  # clients, this code should be removed, and #download_file updated to use that
+  # solution instead.
+  #
+  module Apis
+    module StorageV1
+      class StorageService
+        # Returns a two-element array containing:
+        #   * The `result` that is the usual return type of #get_object.
+        #   * The `http_resp` from DownloadCommand#execute_once.
+        def get_object_with_response(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
+          if download_dest.nil?
+            command =  make_simple_command(:get, 'b/{bucket}/o/{object}', options)
+          else
+            command = make_download_command(:get, 'b/{bucket}/o/{object}', options)
+            command.download_dest = download_dest
+          end
+          command.response_representation = Google::Apis::StorageV1::Object::Representation
+          command.response_class = Google::Apis::StorageV1::Object
+          command.params['bucket'] = bucket unless bucket.nil?
+          command.params['object'] = object unless object.nil?
+          command.query['generation'] = generation unless generation.nil?
+          command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
+          command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
+          command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
+          command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
+          command.query['projection'] = projection unless projection.nil?
+          command.query['userProject'] = user_project unless user_project.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+          execute_or_queue_command_with_response(command, &block)
+        end
+
+        # Returns a two-element array containing:
+        #   * The `result` that is the usual return type of #execute_or_queue_command.
+        #   * The `http_resp` from DownloadCommand#execute_once.
+        def execute_or_queue_command_with_response(command, &callback)
+          batch_command = current_batch
+          if batch_command
+            raise "Can not combine services in a batch" if Thread.current[:google_api_batch_service] != self
+            batch_command.add(command, &callback)
+            nil
+          else
+            command.execute_with_response(client, &callback)
+          end
+        end
+      end
+    end
+    module Core
+      # Streaming/resumable media download support
+      class DownloadCommand < ApiCommand
+        # Returns a two-element array containing:
+        #   * The `result` that is the usual return type of #execute.
+        #   * The `http_resp` from #execute_once.
+        def execute_with_response(client)
+          prepare!
+          begin
+            Retriable.retriable tries: options.retries + 1,
+                                base_interval: 1,
+                                multiplier: 2,
+                                on: RETRIABLE_ERRORS do |try|
+              # This 2nd level retriable only catches auth errors, and supports 1 retry, which allows
+              # auth to be re-attempted without having to retry all sorts of other failures like
+              # NotFound, etc
+              auth_tries = (try == 1 && authorization_refreshable? ? 2 : 1)
+              Retriable.retriable tries: auth_tries,
+                                  on: [Google::Apis::AuthorizationError, Signet::AuthorizationError],
+                                  on_retry: proc { |*| refresh_authorization } do
+                execute_once_with_response(client).tap do |result|
+                  if block_given?
+                    yield result, nil
+                  end
+                end
+              end
+            end
+          rescue => e
+            if block_given?
+              yield nil, e
+            else
+              raise e
+            end
+          end
+        ensure
+          release!
+        end
+
+        # Returns a two-element array containing:
+        #   * The `result` that is the usual return type of #execute_once.
+        #   * The `http_resp`.
+        def execute_once_with_response(client, &block)
+          request_header = header.dup
+          apply_request_options(request_header)
+          download_offset = nil
+
+          if @offset > 0
+            logger.debug { sprintf('Resuming download from offset %d', @offset) }
+            request_header[RANGE_HEADER] = sprintf('bytes=%d-', @offset)
+          end
+
+          http_res = client.get(url.to_s,
+                     query: query,
+                     header: request_header,
+                     follow_redirect: true) do |res, chunk|
+            status = res.http_header.status_code.to_i
+            next unless OK_STATUS.include?(status)
+
+            download_offset ||= (status == 206 ? @offset : 0)
+            download_offset  += chunk.bytesize
+
+            if download_offset - chunk.bytesize == @offset
+              next_chunk = chunk
+            else
+              # Oh no! Requested a chunk, but received the entire content
+              chunk_index = @offset - (download_offset - chunk.bytesize)
+              next_chunk = chunk.byteslice(chunk_index..-1)
+              next if next_chunk.nil?
+            end
+            # logger.debug { sprintf('Writing chunk (%d bytes, %d total)', chunk.length, bytes_read) }
+            @download_io.write(next_chunk)
+
+            @offset += next_chunk.bytesize
+          end
+
+          @download_io.flush
+
+          if @close_io_on_finish
+            result = nil
+          else
+            result = @download_io
+          end
+          check_status(http_res.status.to_i, http_res.header, http_res.body)
+          success([result, http_res], &block)
+        rescue => e
+          @download_io.flush
+          error(e, rethrow: true, &block)
+        end
+      end
+    end
+  end
+  # rubocop:enable all
 end

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

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2016 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Storage
-      VERSION = "1.9.0"
+      VERSION = "1.10.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: google-api-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
@@ -141,16 +141,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -243,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage