gcloud 0.12.2 → 0.20.0

data/lib/gcloud/resource_manager/project/list.rb

@@ -1,167 +0,0 @@
-# Copyright 2015 Google Inc. All rights reserved.
-#
-# 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
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Gcloud
-  module ResourceManager
-    class Project
-      ##
-      # Project::List is a special case Array with additional values.
-      class List < DelegateClass(::Array)
-        ##
-        # If not empty, indicates that there are more projects that match
-        # the request and this value should be passed to continue.
-        attr_accessor :token
-
-        ##
-        # @private Create a new Project::List with an array of Project
-        # instances.
-        def initialize arr = []
-          super arr
-        end
-
-        ##
-        # Whether there is a next page of projects.
-        #
-        # @return [Boolean]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   resource_manager = gcloud.resource_manager
-        #
-        #   projects = resource_manager.projects
-        #   if projects.next?
-        #     next_projects = projects.next
-        #   end
-        #
-        def next?
-          !token.nil?
-        end
-
-        ##
-        # Retrieve the next page of projects.
-        #
-        # @return [Project::List]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   resource_manager = gcloud.resource_manager
-        #
-        #   projects = resource_manager.projects
-        #   if projects.next?
-        #     next_projects = projects.next
-        #   end
-        #
-        def next
-          return nil unless next?
-          ensure_manager!
-          @manager.projects token: token, filter: @filter, max: @max
-        end
-
-        ##
-        # Retrieves all projects by repeatedly loading {#next} until {#next?}
-        # returns `false`. Calls the given block once for each project, which is
-        # passed as the parameter.
-        #
-        # An Enumerator is returned if no block is given.
-        #
-        # This method may make several API calls until all projects are
-        # retrieved. Be sure to use as narrow a search criteria as possible.
-        # Please use with caution.
-        #
-        # @param [Integer] request_limit The upper limit of API requests to make
-        #   to load all projects. Default is no limit.
-        # @yield [project] The block for accessing each project.
-        # @yieldparam [Project] project The project object.
-        #
-        # @return [Enumerator]
-        #
-        # @example Iterating each project by passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   resource_manager = gcloud.resource_manager
-        #   projects = resource_manager.projects
-        #
-        #   projects.all do |project|
-        #     puts project.project_id
-        #   end
-        #
-        # @example Using the enumerator by not passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   resource_manager = gcloud.resource_manager
-        #   projects = resource_manager.projects
-        #
-        #   all_project_ids = projects.all.map do |project|
-        #     project.project_id
-        #   end
-        #
-        # @example Limit the number of API calls made:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   resource_manager = gcloud.resource_manager
-        #   projects = resource_manager.projects
-        #
-        #   projects.all(request_limit: 10) do |project|
-        #     puts project.project_id
-        #   end
-        #
-        def all request_limit: nil
-          request_limit = request_limit.to_i if request_limit
-          unless block_given?
-            return enum_for(:all, request_limit: request_limit)
-          end
-          results = self
-          loop do
-            results.each { |r| yield r }
-            if request_limit
-              request_limit -= 1
-              break if request_limit < 0
-            end
-            break unless results.next?
-            results = results.next
-          end
-        end
-
-        ##
-        # @private New Projects::List from a response object.
-        def self.from_gapi gapi_list, manager, filter = nil, max = nil
-          projects = new(Array(gapi_list.projects).map do |gapi_object|
-            Project.from_gapi gapi_object, manager.service
-          end)
-          projects.instance_variable_set :@token,   gapi_list.next_page_token
-          projects.instance_variable_set :@manager, manager
-          projects.instance_variable_set :@filter,  filter
-          projects.instance_variable_set :@max,     max
-          projects
-        end
-
-        protected
-
-        ##
-        # Raise an error unless an active connection is available.
-        def ensure_manager!
-          fail "Must have active connection" unless @manager
-        end
-      end
-    end
-  end
-end

data/lib/gcloud/resource_manager/project/updater.rb

@@ -1,130 +0,0 @@
-# Copyright 2015 Google Inc. All rights reserved.
-#
-# 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
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-require "time"
-
-module Gcloud
-  module ResourceManager
-    class Project
-      ##
-      # # Project Updater
-      #
-      # This object is used by Project#update when passed a block. These methods
-      # are used to update the project data in a single API call.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   resource_manager = gcloud.resource_manager
-      #   project = resource_manager.project "tokyo-rain-123"
-      #   project.update do |p|
-      #     p.name = "My Project"
-      #     p.labels["env"] = "production"
-      #   end
-      #
-      class Updater < DelegateClass(Project)
-        ##
-        # @private Create an Updater object.
-        def initialize project
-          super project
-        end
-
-        ##
-        # Updates the user-assigned name of the project. This field is optional
-        # and can remain unset.
-        #
-        # Allowed characters are: lowercase and uppercase letters, numbers,
-        # hyphen, single-quote, double-quote, space, and exclamation point.
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   resource_manager = gcloud.resource_manager
-        #   project = resource_manager.project "tokyo-rain-123"
-        #   project.update do |p|
-        #     p.name = "My Project"
-        #   end
-        #
-        def name= new_name
-          gapi.name = new_name
-        end
-
-        ##
-        # The labels associated with this project.
-        #
-        # Label keys must be between 1 and 63 characters long and must conform
-        # to the following regular expression:
-        # <code>[a-z]([-a-z0-9]*[a-z0-9])?</code>.
-        #
-        # Label values must be between 0 and 63 characters long and must conform
-        # to the regular expression <code>([a-z]([-a-z0-9]*[a-z0-9])?)?</code>.
-        #
-        # No more than 256 labels can be associated with a given resource.
-        # (`Hash`)
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   resource_manager = gcloud.resource_manager
-        #   project = resource_manager.project "tokyo-rain-123"
-        #   project.update do |p|
-        #     p.labels["env"] = "production"
-        #   end
-        #
-        def labels
-          gapi.labels
-        end
-
-        ##
-        # Updates the labels associated with this project.
-        #
-        # Label keys must be between 1 and 63 characters long and must conform
-        # to the following regular expression:
-        # <code>[a-z]([-a-z0-9]*[a-z0-9])?</code>.
-        #
-        # Label values must be between 0 and 63 characters long and must conform
-        # to the regular expression <code>([a-z]([-a-z0-9]*[a-z0-9])?)?</code>.
-        #
-        # No more than 256 labels can be associated with a given resource.
-        # (`Hash`)
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   resource_manager = gcloud.resource_manager
-        #   project = resource_manager.project "tokyo-rain-123"
-        #   project.update do |p|
-        #     p.labels = { "env" => "production" }
-        #   end
-        #
-        def labels= new_labels
-          gapi.labels = new_labels
-        end
-
-        ##
-        # @private Create an Updater object.
-        def self.from_project project
-          dupe_gapi = project.gapi.class.new project.gapi.to_h
-          dupe_project = Project.from_gapi dupe_gapi, nil # no way to update
-          Updater.new dupe_project
-        end
-      end
-    end
-  end
-end

data/lib/gcloud/resource_manager/service.rb

@@ -1,127 +0,0 @@
-# Copyright 2016 Google Inc. All rights reserved.
-#
-# 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
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-require "gcloud/version"
-require "gcloud/errors"
-require "google/apis/cloudresourcemanager_v1"
-
-module Gcloud
-  module ResourceManager
-    ##
-    # @private
-    # Represents the service to Resource Manager, as well as expose the API
-    # calls.
-    class Service
-      ##
-      # Alias to the Google Client API module
-      API = Google::Apis::CloudresourcemanagerV1
-
-      attr_accessor :credentials
-
-      ##
-      # Creates a new Service instance.
-      def initialize credentials, retries: nil, timeout: nil
-        @credentials = credentials
-        @service = API::CloudResourceManagerService.new
-        @service.client_options.application_name    = "gcloud-ruby"
-        @service.client_options.application_version = Gcloud::VERSION
-        @service.request_options.retries = retries || 3
-        @service.request_options.timeout_sec = timeout if timeout
-        @service.authorization = @credentials.client
-      end
-
-      def service
-        return mocked_service if mocked_service
-        @service
-      end
-      attr_accessor :mocked_service
-
-      ##
-      # Returns API::ListProjectsResponse
-      def list_project filter: nil, token: nil, max: nil
-        service.list_projects page_token: token, page_size: max, filter: filter
-      end
-
-      ##
-      # Returns API::Project
-      def get_project project_id
-        service.get_project project_id
-      rescue Google::Apis::Error => e
-        raise Gcloud::Error.from_error(e)
-      end
-
-      ##
-      # Returns API::Project
-      def create_project project_id, name, labels
-        project_attrs = { projectId: project_id, name: name,
-                          labels: labels }.delete_if { |_, v| v.nil? }
-        service.create_project API::Project.new(project_attrs)
-      rescue Google::Apis::Error => e
-        raise Gcloud::Error.from_error(e)
-      end
-
-      ##
-      # Updated the project, given a API::Project.
-      # Returns API::Project
-      def update_project project_gapi
-        service.update_project project_gapi.project_id, project_gapi
-      rescue Google::Apis::Error => e
-        raise Gcloud::Error.from_error(e)
-      end
-
-      def delete_project project_id
-        service.delete_project project_id
-      rescue Google::Apis::Error => e
-        raise Gcloud::Error.from_error(e)
-      end
-
-      def undelete_project project_id
-        service.undelete_project project_id
-      rescue Google::Apis::Error => e
-        raise Gcloud::Error.from_error(e)
-      end
-
-      ##
-      # Returns API::Policy
-      def get_policy project_id
-        service.get_project_iam_policy "projects/#{project_id}"
-      rescue Google::Apis::Error => e
-        raise Gcloud::Error.from_error(e)
-      end
-
-      ##
-      # Returns API::Policy
-      def set_policy project_id, new_policy
-        req = API::SetIamPolicyRequest.new policy: new_policy
-        service.set_project_iam_policy "projects/#{project_id}", req
-      rescue Google::Apis::Error => e
-        raise Gcloud::Error.from_error(e)
-      end
-
-      ##
-      # Returns API::TestIamPermissionsResponse
-      def test_permissions project_id, permissions
-        req = API::TestIamPermissionsRequest.new permissions: permissions
-        service.test_project_iam_permissions "projects/#{project_id}", req
-      rescue Google::Apis::Error => e
-        raise Gcloud::Error.from_error(e)
-      end
-
-      def inspect
-        "#{self.class}"
-      end
-    end
-  end
-end

data/lib/gcloud/storage/bucket.rb

@@ -1,775 +0,0 @@
-# Copyright 2014 Google Inc. All rights reserved.
-#
-# 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
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-require "gcloud/storage/bucket/acl"
-require "gcloud/storage/bucket/list"
-require "gcloud/storage/bucket/cors"
-require "gcloud/storage/file"
-require "pathname"
-
-module Gcloud
-  module Storage
-    ##
-    # # Bucket
-    #
-    # Represents a Storage bucket. Belongs to a Project and has many Files.
-    #
-    # @example
-    #   require "gcloud"
-    #
-    #   gcloud = Gcloud.new
-    #   storage = gcloud.storage
-    #
-    #   bucket = storage.bucket "my-bucket"
-    #   file = bucket.file "path/to/my-file.ext"
-    #
-    class Bucket
-      ##
-      # @private The Service object.
-      attr_accessor :service
-
-      ##
-      # @private The Google API Client object.
-      attr_accessor :gapi
-
-      ##
-      # @private Create an empty Bucket object.
-      def initialize
-        @service = nil
-        @gapi = Google::Apis::StorageV1::Bucket.new
-      end
-
-      ##
-      # The kind of item this is.
-      # For buckets, this is always `storage#bucket`.
-      def kind
-        @gapi.kind
-      end
-
-      ##
-      # The ID of the bucket.
-      def id
-        @gapi.id
-      end
-
-      ##
-      # The name of the bucket.
-      def name
-        @gapi.name
-      end
-
-      ##
-      # A URL that can be used to access the bucket using the REST API.
-      def api_url
-        @gapi.self_link
-      end
-
-      ##
-      # Creation time of the bucket.
-      def created_at
-        @gapi.time_created
-      end
-
-      ##
-      # Returns the current CORS configuration for a static website served from
-      # the bucket.
-      #
-      # The return value is a frozen (unmodifiable) array of hashes containing
-      # the attributes specified for the Bucket resource field
-      # [cors](https://cloud.google.com/storage/docs/json_api/v1/buckets#cors).
-      #
-      # This method also accepts a block for updating the bucket's CORS rules.
-      # See {Bucket::Cors} for details.
-      #
-      # @see https://cloud.google.com/storage/docs/cross-origin Cross-Origin
-      #   Resource Sharing (CORS)
-      #
-      # @yield [cors] a block for setting CORS rules
-      # @yieldparam [Bucket::Cors] cors the object accepting CORS rules
-      #
-      # @example Retrieving the bucket's CORS rules.
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-todo-app"
-      #   bucket.cors #=> [{"origin"=>["http://example.org"],
-      #               #     "method"=>["GET","POST","DELETE"],
-      #               #     "responseHeader"=>["X-My-Custom-Header"],
-      #               #     "maxAgeSeconds"=>3600}]
-      #
-      # @example Updating the bucket's CORS rules inside a block.
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #   bucket = storage.bucket "my-todo-app"
-      #
-      #   bucket.update do |b|
-      #     b.cors do |c|
-      #       c.add_rule ["http://example.org", "https://example.org"],
-      #                  "*",
-      #                  response_headers: ["X-My-Custom-Header"],
-      #                  max_age: 3600
-      #     end
-      #   end
-      #
-      def cors
-        cors_builder = Bucket::Cors.from_gapi @gapi.cors_configurations
-        if block_given?
-          yield cors_builder
-          if cors_builder.changed?
-            @gapi.cors_configurations = cors_builder.to_gapi
-            patch_gapi! :cors_configurations
-          end
-        end
-        cors_builder.freeze # always return frozen objects
-      end
-
-      ##
-      # The location of the bucket.
-      # Object data for objects in the bucket resides in physical
-      # storage within this region. Defaults to US.
-      # See the developer's guide for the authoritative list.
-      #
-      # @see https://cloud.google.com/storage/docs/concepts-techniques
-      def location
-        @gapi.location
-      end
-
-      ##
-      # The destination bucket name for the bucket's logs.
-      #
-      # @see https://cloud.google.com/storage/docs/access-logs Access Logs
-      #
-      def logging_bucket
-        @gapi.logging.log_bucket if @gapi.logging
-      end
-
-      ##
-      # Updates the destination bucket for the bucket's logs.
-      #
-      # @see https://cloud.google.com/storage/docs/access-logs Access Logs
-      #
-      # @param [String] logging_bucket The bucket to hold the logging output
-      #
-      def logging_bucket= logging_bucket
-        @gapi.logging ||= Google::Apis::StorageV1::Bucket::Logging.new
-        @gapi.logging.log_bucket = logging_bucket
-        patch_gapi! :logging
-      end
-
-      ##
-      # The logging object prefix for the bucket's logs. For more information,
-      #
-      # @see https://cloud.google.com/storage/docs/access-logs Access Logs
-      #
-      def logging_prefix
-        @gapi.logging.log_object_prefix if @gapi.logging
-      end
-
-      ##
-      # Updates the logging object prefix. This prefix will be used to create
-      # log object names for the bucket. It can be at most 900 characters and
-      # must be a [valid object
-      # name](https://cloud.google.com/storage/docs/bucket-naming#objectnames).
-      # By default, the object prefix is the name
-      # of the bucket for which the logs are enabled.
-      #
-      # @see https://cloud.google.com/storage/docs/access-logs Access Logs
-      #
-      def logging_prefix= logging_prefix
-        @gapi.logging ||= Google::Apis::StorageV1::Bucket::Logging.new
-        @gapi.logging.log_object_prefix = logging_prefix
-        patch_gapi! :logging
-      end
-
-      ##
-      # The bucket's storage class. This defines how objects in the bucket are
-      # stored and determines the SLA and the cost of storage. Values include
-      # `STANDARD`, `NEARLINE`, and `DURABLE_REDUCED_AVAILABILITY`.
-      def storage_class
-        @gapi.storage_class
-      end
-
-      ##
-      # Whether [Object
-      # Versioning](https://cloud.google.com/storage/docs/object-versioning) is
-      # enabled for the bucket.
-      def versioning?
-        @gapi.versioning.enabled? unless @gapi.versioning.nil?
-      end
-
-      ##
-      # Updates whether [Object
-      # Versioning](https://cloud.google.com/storage/docs/object-versioning) is
-      # enabled for the bucket.
-      #
-      # @return [Boolean]
-      #
-      def versioning= new_versioning
-        @gapi.versioning ||= Google::Apis::StorageV1::Bucket::Versioning.new
-        @gapi.versioning.enabled = new_versioning
-        patch_gapi! :versioning
-      end
-
-      ##
-      # The index page returned from a static website served from the bucket
-      # when a site visitor requests the top level directory.
-      #
-      # @see https://cloud.google.com/storage/docs/website-configuration#step4
-      #   How to Host a Static Website
-      #
-      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.
-      #
-      # @see https://cloud.google.com/storage/docs/website-configuration#step4
-      #   How to Host a Static Website
-      #
-      def website_main= website_main
-        @gapi.website ||= Google::Apis::StorageV1::Bucket::Website.new
-        @gapi.website.main_page_suffix = website_main
-        patch_gapi! :website
-      end
-
-      ##
-      # The page returned from a static website served from the bucket when a
-      # site visitor requests a resource that does not exist.
-      #
-      # @see https://cloud.google.com/storage/docs/website-configuration#step4
-      #   How to Host a Static Website
-      #
-      def website_404
-        @gapi.website.not_found_page if @gapi.website
-      end
-
-      ##
-      # Updates the page returned from a static website served from the bucket
-      # when a site visitor requests a resource that does not exist.
-      #
-      # @see https://cloud.google.com/storage/docs/website-configuration#step4
-      #   How to Host a Static Website
-      #
-      def website_404= website_404
-        @gapi.website ||= Google::Apis::StorageV1::Bucket::Website.new
-        @gapi.website.not_found_page = website_404
-        patch_gapi! :website
-      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})
-      #
-      # @yield [bucket] a block yielding a delegate object for updating the file
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-bucket"
-      #   bucket.update do |b|
-      #     b.website_main = "index.html"
-      #     b.website_404 = "not_found.html"
-      #     b.cors[0]["method"] = ["GET","POST","DELETE"]
-      #     b.cors[1]["responseHeader"] << "X-Another-Custom-Header"
-      #   end
-      #
-      # @example New CORS rules can also be added in a nested block:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #   bucket = storage.bucket "my-todo-app"
-      #
-      #   bucket.update do |b|
-      #     b.cors do |c|
-      #       c.add_rule ["http://example.org", "https://example.org"],
-      #                  "*",
-      #                  response_headers: ["X-My-Custom-Header"],
-      #                  max_age: 300
-      #     end
-      #   end
-      #
-      def update
-        updater = Updater.new @gapi
-        yield updater
-        # Add check for mutable cors
-        updater.check_for_mutable_cors!
-        patch_gapi! updater.updates unless updater.updates.empty?
-      end
-
-      ##
-      # Permanently deletes the bucket.
-      # The bucket must be empty before it can be deleted.
-      #
-      # The API call to delete the bucket may be retried under certain
-      # conditions. See {Gcloud#storage} to control this behavior.
-      #
-      # @return [Boolean] Returns `true` if the bucket was deleted.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-bucket"
-      #   bucket.delete
-      #
-      def delete
-        ensure_service!
-        service.delete_bucket name
-        true
-      end
-
-      ##
-      # Retrieves a list of files matching the criteria.
-      #
-      # @param [String] prefix Filter results to files whose names begin with
-      #   this prefix.
-      # @param [String] delimiter Returns results in a directory-like mode.
-      #   `items` will contain only objects whose names, aside from the
-      #   `prefix`, do not contain `delimiter`. Objects whose names, aside from
-      #   the `prefix`, contain `delimiter` will have their name, truncated
-      #   after the `delimiter`, returned in `prefixes`. Duplicate `prefixes`
-      #   are omitted.
-      # @param [String] token A previously-returned page token representing part
-      #   of the larger set of results to view.
-      # @param [Integer] max Maximum number of items plus prefixes to return. As
-      #   duplicate prefixes are omitted, fewer total results may be returned
-      #   than requested. The default value of this parameter is 1,000 items.
-      # @param [Boolean] versions If `true`, lists all versions of an object as
-      #   distinct results. The default is `false`. For more information, see
-      #   [Object Versioning
-      #   ](https://cloud.google.com/storage/docs/object-versioning).
-      #
-      # @return [Array<Gcloud::Storage::File>] (See
-      #   {Gcloud::Storage::File::List})
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-bucket"
-      #   files = bucket.files
-      #   files.each do |file|
-      #     puts file.name
-      #   end
-      #
-      # @example Retrieve all files: (See {File::List#all})
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-bucket"
-      #   files = bucket.files
-      #   files.all do |file|
-      #     puts file.name
-      #   end
-      #
-      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
-        File::List.from_gapi gapi, service, name, prefix, delimiter, max,
-                             versions
-      end
-      alias_method :find_files, :files
-
-      ##
-      # Retrieves a file matching the path.
-      #
-      # If a [customer-supplied encryption
-      # key](https://cloud.google.com/storage/docs/encryption#customer-supplied)
-      # was used with {#create_file}, the `encryption_key` and
-      # `encryption_key_sha256` options must be provided or else the file's
-      # CRC32C checksum and MD5 hash will not be returned.
-      #
-      # @param [String] path Name (path) of the file.
-      # @param [Integer] generation When present, selects a specific revision of
-      #   this object. Default is the latest version.
-      # @param [String] encryption_key Optional. The customer-supplied, AES-256
-      #   encryption key used to encrypt the file, if one was provided to
-      #   {#create_file}. Must be provided if `encryption_key_sha256` is
-      #   provided.
-      # @param [String] encryption_key_sha256 Optional. The SHA256 hash of the
-      #   customer-supplied, AES-256 encryption key used to encrypt the file, if
-      #   one was provided to {#create_file}. Must be provided if
-      #   `encryption_key` is provided.
-      #
-      # @return [Gcloud::Storage::File, nil] Returns nil if file does not exist
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-bucket"
-      #
-      #   file = bucket.file "path/to/my-file.ext"
-      #   puts file.name
-      #
-      def file path, generation: nil, encryption_key: nil,
-               encryption_key_sha256: nil
-        ensure_service!
-        options = { generation: generation, key: encryption_key,
-                    key_sha256: encryption_key_sha256 }
-        gapi = service.get_file name, path, options
-        File.from_gapi gapi, service
-      rescue Gcloud::NotFoundError
-        nil
-      end
-      alias_method :find_file, :file
-
-      ##
-      # Creates a new {File} object by providing a path to a local file to
-      # upload and the path to store it with in the bucket.
-      #
-      # #### Customer-supplied encryption keys
-      #
-      # By default, Google Cloud Storage manages server-side encryption keys on
-      # your behalf. However, a [customer-supplied encryption
-      # key](https://cloud.google.com/storage/docs/encryption#customer-supplied)
-      # can be provided with the `encryption_key` and `encryption_key_sha256`
-      # options. If given, the same key and SHA256 hash also must be provided to
-      # subsequently download or copy the file. If you use customer-supplied
-      # encryption keys, you must securely manage your keys and ensure that they
-      # are not lost. Also, please note that file metadata is not encrypted,
-      # with the exception of the CRC32C checksum and MD5 hash. The names of
-      # files and buckets are also not encrypted, and you can read or update the
-      # metadata of an encrypted file without providing the encryption key.
-      #
-      # @param [String] file Path of the file on the filesystem to upload.
-      # @param [String] path Path to store the file in Google Cloud Storage.
-      # @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] cache_control The
-      #   [Cache-Control](https://tools.ietf.org/html/rfc7234#section-5.2)
-      #   response header to be returned when the file is downloaded.
-      # @param [String] content_disposition The
-      #   [Content-Disposition](https://tools.ietf.org/html/rfc6266)
-      #   response header to be returned when the file is downloaded.
-      # @param [String] content_encoding The [Content-Encoding
-      #   ](https://tools.ietf.org/html/rfc7231#section-3.1.2.2) response header
-      #   to be returned when the file is downloaded.
-      # @param [String] content_language The
-      #   [Content-Language](http://tools.ietf.org/html/bcp47) response
-      #   header to be returned when the file is downloaded.
-      # @param [String] content_type The
-      #   [Content-Type](https://tools.ietf.org/html/rfc2616#section-14.17)
-      #   response header to be returned when the file is downloaded.
-      # @param [String] crc32c The CRC32c checksum of the file data, as
-      #   described in [RFC 4960, Appendix
-      #   B](http://tools.ietf.org/html/rfc4960#appendix-B).
-      #   If provided, Cloud Storage will only create the file if the value
-      #   matches the value calculated by the service. See
-      #   [Validation](https://cloud.google.com/storage/docs/hashes-etags)
-      #   for more information.
-      # @param [String] md5 The MD5 hash of the file data. If provided, Cloud
-      #   Storage will only create the file if the value matches the value
-      #   calculated by the service. See
-      #   [Validation](https://cloud.google.com/storage/docs/hashes-etags) for
-      #   more information.
-      # @param [Hash] metadata 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.
-      # @param [String] encryption_key Optional. A customer-supplied, AES-256
-      #   encryption key that will be used to encrypt the file. Must be provided
-      #   if `encryption_key_sha256` is provided.
-      # @param [String] encryption_key_sha256 Optional. The SHA256 hash of the
-      #   customer-supplied, AES-256 encryption key that will be used to encrypt
-      #   the file. Must be provided if `encryption_key` is provided.
-      #
-      # @return [Gcloud::Storage::File]
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-bucket"
-      #
-      #   bucket.create_file "path/to/local.file.ext"
-      #
-      # @example Specifying a destination path:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-bucket"
-      #
-      #   bucket.create_file "path/to/local.file.ext",
-      #                      "destination/path/file.ext"
-      #
-      # @example Providing a customer-supplied encryption key:
-      #   require "gcloud"
-      #   require "digest/sha2"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #   bucket = storage.bucket "my-bucket"
-      #
-      #   # Key generation shown for example purposes only. Write your own.
-      #   cipher = OpenSSL::Cipher.new "aes-256-cfb"
-      #   cipher.encrypt
-      #   key = cipher.random_key
-      #   key_hash = Digest::SHA256.digest key
-      #
-      #   bucket.create_file "path/to/local.file.ext",
-      #                      "destination/path/file.ext",
-      #                      encryption_key: key,
-      #                      encryption_key_sha256: key_hash
-      #
-      #   # Store your key and hash securely for later use.
-      #   file = bucket.file "destination/path/file.ext",
-      #                      encryption_key: key,
-      #                      encryption_key_sha256: key_hash
-      #
-      def create_file file, path = nil, acl: nil, cache_control: nil,
-                      content_disposition: nil, content_encoding: nil,
-                      content_language: nil, content_type: nil,
-                      crc32c: nil, md5: nil, metadata: nil, encryption_key: nil,
-                      encryption_key_sha256: nil
-        ensure_service!
-        options = { acl: File::Acl.predefined_rule_for(acl), md5: md5,
-                    cache_control: cache_control, content_type: content_type,
-                    content_disposition: content_disposition, crc32c: crc32c,
-                    content_encoding: content_encoding,
-                    content_language: content_language, metadata: metadata,
-                    key: encryption_key, key_sha256: encryption_key_sha256 }
-        ensure_file_exists! file
-        # TODO: Handle file as an IO and path is missing more gracefully
-        path ||= Pathname(file).to_path
-        gapi = service.insert_file name, file, path, options
-        File.from_gapi gapi, service
-      end
-      alias_method :upload_file, :create_file
-      alias_method :new_file, :create_file
-
-      ##
-      # 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 well as
-      # many predefined lists.
-      #
-      # @see https://cloud.google.com/storage/docs/access-control Access Control
-      #   guide
-      #
-      # @example Grant access to a user by pre-pending `"user-"` to an email:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-todo-app"
-      #
-      #   email = "heidi@example.net"
-      #   bucket.acl.add_reader "user-#{email}"
-      #
-      # @example Grant access to a group by pre-pending `"group-"` to an email:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-todo-app"
-      #
-      #   email = "authors@example.net"
-      #   bucket.acl.add_reader "group-#{email}"
-      #
-      # @example Or, grant access via a predefined permissions list:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-todo-app"
-      #
-      #   bucket.acl.public!
-      #
-      def acl
-        @acl ||= Bucket::Acl.new self
-      end
-
-      ##
-      # 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 address,
-      # as well as many predefined lists.
-      #
-      # @see https://cloud.google.com/storage/docs/access-control Access Control
-      #   guide
-      #
-      # @example Grant access to a user by pre-pending `"user-"` to an email:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-todo-app"
-      #
-      #   email = "heidi@example.net"
-      #   bucket.default_acl.add_reader "user-#{email}"
-      #
-      # @example Grant access to a group by pre-pending `"group-"` to an email
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-todo-app"
-      #
-      #   email = "authors@example.net"
-      #   bucket.default_acl.add_reader "group-#{email}"
-      #
-      # @example Or, grant access via a predefined permissions list:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   storage = gcloud.storage
-      #
-      #   bucket = storage.bucket "my-todo-app"
-      #
-      #   bucket.default_acl.public!
-      #
-      def default_acl
-        @default_acl ||= Bucket::DefaultAcl.new self
-      end
-
-      ##
-      # Reloads the bucket with current data from the Storage service.
-      def reload!
-        ensure_service!
-        @gapi = service.get_bucket name
-      end
-      alias_method :refresh!, :reload!
-
-      ##
-      # @private New Bucket from a Google API Client object.
-      def self.from_gapi gapi, conn
-        new.tap do |f|
-          f.gapi = gapi
-          f.service = conn
-        end
-      end
-
-      protected
-
-      ##
-      # Raise an error unless an active service is available.
-      def ensure_service!
-        fail "Must have active connection" unless service
-      end
-
-      def patch_gapi! *attributes
-        attributes.flatten!
-        return if attributes.empty?
-        ensure_service!
-        patch_args = Hash[attributes.map do |attr|
-          [attr, @gapi.send(attr)]
-        end]
-        patch_gapi = Google::Apis::StorageV1::Bucket.new patch_args
-        @gapi = service.patch_bucket name, patch_gapi
-      end
-
-      ##
-      # Raise an error if the file is not found.
-      def ensure_file_exists! file
-        return if ::File.file? file
-        fail ArgumentError, "cannot find file #{file}"
-      end
-
-      ##
-      # Yielded to a block to accumulate changes for a patch request.
-      class Updater < Bucket
-        attr_reader :updates
-        ##
-        # Create an Updater object.
-        def initialize gapi
-          @updates = []
-          @gapi = gapi
-          @cors_builder = nil
-        end
-
-        def cors
-          # Same as Bucket#cors, but not frozen
-          @cors_builder ||= Bucket::Cors.from_gapi @gapi.cors_configurations
-          yield @cors_builder if block_given?
-          @cors_builder
-        end
-
-        ##
-        # @private Make sure any cors changes are saved
-        def check_for_mutable_cors!
-          return if @cors_builder.nil?
-          return unless @cors_builder.changed?
-          @gapi.cors_configurations = @cors_builder.to_gapi
-          patch_gapi! :cors_configurations
-        end
-
-        protected
-
-        ##
-        # Queue up all the updates instead of making them.
-        def patch_gapi! attribute
-          @updates << attribute
-          @updates.uniq!
-        end
-      end
-    end
-  end
-end